agentleFS
narenaryannarenaryan/agent-skills/skills/go/go-interfaces-embedding/SKILL.md

go-interfaces-embedding

Skill0 starsChanged 39 days agoMITView on GitHub

Use when designing Go type hierarchies with interfaces, type switches, or struct/interface embedding — covers implicit satisfaction, comma-ok assertions, compile-time interface checks via var _, method promotion rules, and name-collision resolution

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Empty interface: prefer any (Go 1.18+) over interface{}.

    line 80

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Go Interfaces & Embedding

Interface satisfaction is implicit and structural. Embedding promotes the inner type's method set; the receiver stays the inner type. Composition, not inheritance — no virtual dispatch.

Type switch vs assertion

switch t := v.(type) {
case int:   use(t)      // t is int
case *Foo:  use(t)      // t is *Foo
default:                // t keeps interface type
}

s, ok := v.(string)     // comma-ok avoids panic

Bare v.(string) panics on mismatch.

Compile-time interface compliance

var _ json.Marshaler = (*RawMessage)(nil)

Breaks the build if *RawMessage stops implementing Marshaler. Use when no other static conversion in the package already proves it.

Embedding: method promotion

type ReadWriter struct {
    *Reader
    *Writer
}
rw.Read(p)    // dispatches to (*Reader).Read; receiver is rw.Reader

The promoted method's receiver is the embedded value. An inner method calling m.Other() sees the inner Other, not any outer shadow — you cannot override polymorphically, only shadow at the outer level.

Name collisions

SituationBehavior
Outer same name as embeddedOuter shadows; reach inner via type name j.Logger.Println
Same name, same depthCompile error only if referenced
Different depthsShallower wins

Access embedded fields by type name (minus package): j.Logger.

Interface embedding

type ReadWriter interface {
    Reader
    Writer
}

Union of method sets. Only between interfaces — cannot embed an interface in a struct to declare required methods.

Receivers and interfaces

HolderMethod set
T valueT receivers only
*T valueT and *T receivers

A T value does not satisfy an interface whose method uses a pointer receiver.

Pitfalls

  • Recursive String(): fmt.Sprintf("%s", x) inside (x T) String() recurses. Convert: fmt.Sprint([]int(x)).
  • Discarding errors with _: fi, _ := os.Stat(p); fi.IsDir() nil-panics on failure.
  • Assuming polymorphism: an inner method calling m.Other() calls the inner Other, not an outer shadow.
  • Nil interface vs nil concrete: var p *T; var i Iface = p; i == nil is false — interface holds (type, value) and type is non-nil.
  • Empty interface: prefer any (Go 1.18+) over interface{}; identical.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.