Help us shape the future of Go! Take the 2026 Go Developer Survey

notes

package
v0.57.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 7, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Blog 

type Blog struct {

	// Name is the display name of the blog.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description is a short description of the blog.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Sources is the ordered list of content sources (shared with Notebook).
	Sources []*NotebookSource `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
	// AuthorRegistryPath is the path to the authors.yaml file within the source.
	AuthorRegistryPath string `protobuf:"bytes,4,opt,name=author_registry_path,json=authorRegistryPath,proto3" json:"authorRegistryPath,omitempty"`
	// contains filtered or unexported fields
}

Blog is a world object that presents markdown files from UnixFS sources as a blog with reading view and frontmatter-based filtering.

func (*Blog) CloneMessageVT 

func (m *Blog) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Blog) CloneVT 

func (m *Blog) CloneVT() *Blog

func (*Blog) EqualMessageVT 

func (this *Blog) EqualMessageVT(thatMsg any) bool

func (*Blog) EqualVT 

func (this *Blog) EqualVT(that *Blog) bool

func (*Blog) GetAuthorRegistryPath 

func (x *Blog) GetAuthorRegistryPath() string

func (*Blog) GetDescription 

func (x *Blog) GetDescription() string

func (*Blog) GetName 

func (x *Blog) GetName() string

func (*Blog) GetSources 

func (x *Blog) GetSources() []*NotebookSource

func (*Blog) MarshalJSON 

func (x *Blog) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Blog to JSON.

func (*Blog) MarshalProtoJSON 

func (x *Blog) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Blog message to JSON.

func (*Blog) MarshalProtoText 

func (x *Blog) MarshalProtoText() string

func (*Blog) MarshalToSizedBufferVT 

func (m *Blog) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Blog) MarshalToVT 

func (m *Blog) MarshalToVT(dAtA []byte) (int, error)

func (*Blog) MarshalVT 

func (m *Blog) MarshalVT() (dAtA []byte, err error)

func (*Blog) ProtoMessage 

func (*Blog) ProtoMessage()

func (*Blog) Reset 

func (x *Blog) Reset()

func (*Blog) SizeVT 

func (m *Blog) SizeVT() (n int)

func (*Blog) String 

func (x *Blog) String() string

func (*Blog) UnmarshalJSON 

func (x *Blog) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Blog from JSON.

func (*Blog) UnmarshalProtoJSON 

func (x *Blog) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Blog message from JSON.

func (*Blog) UnmarshalVT 

func (m *Blog) UnmarshalVT(dAtA []byte) error

type CreateBlogOp 

type CreateBlogOp struct {

	// ObjectKey is the world object key for the blog.
	ObjectKey string `protobuf:"bytes,1,opt,name=object_key,json=objectKey,proto3" json:"objectKey,omitempty"`
	// Name is the display name for the blog.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description is a short description of the blog.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// AuthorRegistryPath is the path to the authors.yaml file.
	AuthorRegistryPath string `protobuf:"bytes,4,opt,name=author_registry_path,json=authorRegistryPath,proto3" json:"authorRegistryPath,omitempty"`
	// Timestamp is the creation timestamp.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

CreateBlogOp creates a Blog with a UnixFS source and initial post.

func (*CreateBlogOp) CloneMessageVT 

func (m *CreateBlogOp) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*CreateBlogOp) CloneVT 

func (m *CreateBlogOp) CloneVT() *CreateBlogOp

func (*CreateBlogOp) EqualMessageVT 

func (this *CreateBlogOp) EqualMessageVT(thatMsg any) bool

func (*CreateBlogOp) EqualVT 

func (this *CreateBlogOp) EqualVT(that *CreateBlogOp) bool

func (*CreateBlogOp) GetAuthorRegistryPath 

func (x *CreateBlogOp) GetAuthorRegistryPath() string

func (*CreateBlogOp) GetDescription 

func (x *CreateBlogOp) GetDescription() string

func (*CreateBlogOp) GetName 

func (x *CreateBlogOp) GetName() string

func (*CreateBlogOp) GetObjectKey 

func (x *CreateBlogOp) GetObjectKey() string

func (*CreateBlogOp) GetTimestamp 

func (x *CreateBlogOp) GetTimestamp() *timestamppb.Timestamp

func (*CreateBlogOp) MarshalJSON 

func (x *CreateBlogOp) MarshalJSON() ([]byte, error)

MarshalJSON marshals the CreateBlogOp to JSON.

func (*CreateBlogOp) MarshalProtoJSON 

func (x *CreateBlogOp) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the CreateBlogOp message to JSON.

func (*CreateBlogOp) MarshalProtoText 

func (x *CreateBlogOp) MarshalProtoText() string

func (*CreateBlogOp) MarshalToSizedBufferVT 

func (m *CreateBlogOp) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*CreateBlogOp) MarshalToVT 

func (m *CreateBlogOp) MarshalToVT(dAtA []byte) (int, error)

func (*CreateBlogOp) MarshalVT 

func (m *CreateBlogOp) MarshalVT() (dAtA []byte, err error)

func (*CreateBlogOp) ProtoMessage 

func (*CreateBlogOp) ProtoMessage()

func (*CreateBlogOp) Reset 

func (x *CreateBlogOp) Reset()

func (*CreateBlogOp) SizeVT 

func (m *CreateBlogOp) SizeVT() (n int)

func (*CreateBlogOp) String 

func (x *CreateBlogOp) String() string

func (*CreateBlogOp) UnmarshalJSON 

func (x *CreateBlogOp) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the CreateBlogOp from JSON.

func (*CreateBlogOp) UnmarshalProtoJSON 

func (x *CreateBlogOp) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the CreateBlogOp message from JSON.

func (*CreateBlogOp) UnmarshalVT 

func (m *CreateBlogOp) UnmarshalVT(dAtA []byte) error

type CreateDocumentationOp 

type CreateDocumentationOp struct {

	// ObjectKey is the world object key for the documentation.
	ObjectKey string `protobuf:"bytes,1,opt,name=object_key,json=objectKey,proto3" json:"objectKey,omitempty"`
	// Name is the display name for the documentation.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description is a short description of the documentation.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Timestamp is the creation timestamp.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

CreateDocumentationOp creates a Documentation with a UnixFS source and initial page.

func (*CreateDocumentationOp) CloneMessageVT 

func (m *CreateDocumentationOp) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*CreateDocumentationOp) CloneVT 

func (m *CreateDocumentationOp) CloneVT() *CreateDocumentationOp

func (*CreateDocumentationOp) EqualMessageVT 

func (this *CreateDocumentationOp) EqualMessageVT(thatMsg any) bool

func (*CreateDocumentationOp) EqualVT 

func (this *CreateDocumentationOp) EqualVT(that *CreateDocumentationOp) bool

func (*CreateDocumentationOp) GetDescription 

func (x *CreateDocumentationOp) GetDescription() string

func (*CreateDocumentationOp) GetName 

func (x *CreateDocumentationOp) GetName() string

func (*CreateDocumentationOp) GetObjectKey 

func (x *CreateDocumentationOp) GetObjectKey() string

func (*CreateDocumentationOp) GetTimestamp 

func (x *CreateDocumentationOp) GetTimestamp() *timestamppb.Timestamp

func (*CreateDocumentationOp) MarshalJSON 

func (x *CreateDocumentationOp) MarshalJSON() ([]byte, error)

MarshalJSON marshals the CreateDocumentationOp to JSON.

func (*CreateDocumentationOp) MarshalProtoJSON 

func (x *CreateDocumentationOp) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the CreateDocumentationOp message to JSON.

func (*CreateDocumentationOp) MarshalProtoText 

func (x *CreateDocumentationOp) MarshalProtoText() string

func (*CreateDocumentationOp) MarshalToSizedBufferVT 

func (m *CreateDocumentationOp) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*CreateDocumentationOp) MarshalToVT 

func (m *CreateDocumentationOp) MarshalToVT(dAtA []byte) (int, error)

func (*CreateDocumentationOp) MarshalVT 

func (m *CreateDocumentationOp) MarshalVT() (dAtA []byte, err error)

func (*CreateDocumentationOp) ProtoMessage 

func (*CreateDocumentationOp) ProtoMessage()

func (*CreateDocumentationOp) Reset 

func (x *CreateDocumentationOp) Reset()

func (*CreateDocumentationOp) SizeVT 

func (m *CreateDocumentationOp) SizeVT() (n int)

func (*CreateDocumentationOp) String 

func (x *CreateDocumentationOp) String() string

func (*CreateDocumentationOp) UnmarshalJSON 

func (x *CreateDocumentationOp) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the CreateDocumentationOp from JSON.

func (*CreateDocumentationOp) UnmarshalProtoJSON 

func (x *CreateDocumentationOp) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the CreateDocumentationOp message from JSON.

func (*CreateDocumentationOp) UnmarshalVT 

func (m *CreateDocumentationOp) UnmarshalVT(dAtA []byte) error

type Documentation 

type Documentation struct {

	// Name is the display name of the documentation site.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description is a short description of the documentation.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Sources is the ordered list of content sources (shared with Notebook).
	Sources []*NotebookSource `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
	// CreatedAt is the creation timestamp.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"createdAt,omitempty"`
	// contains filtered or unexported fields
}

Documentation is a world object that presents markdown files from UnixFS sources as a documentation site with sidebar navigation and page viewer.

func (*Documentation) CloneMessageVT 

func (m *Documentation) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Documentation) CloneVT 

func (m *Documentation) CloneVT() *Documentation

func (*Documentation) EqualMessageVT 

func (this *Documentation) EqualMessageVT(thatMsg any) bool

func (*Documentation) EqualVT 

func (this *Documentation) EqualVT(that *Documentation) bool

func (*Documentation) GetCreatedAt 

func (x *Documentation) GetCreatedAt() *timestamppb.Timestamp

func (*Documentation) GetDescription 

func (x *Documentation) GetDescription() string

func (*Documentation) GetName 

func (x *Documentation) GetName() string

func (*Documentation) GetSources 

func (x *Documentation) GetSources() []*NotebookSource

func (*Documentation) MarshalJSON 

func (x *Documentation) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Documentation to JSON.

func (*Documentation) MarshalProtoJSON 

func (x *Documentation) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Documentation message to JSON.

func (*Documentation) MarshalProtoText 

func (x *Documentation) MarshalProtoText() string

func (*Documentation) MarshalToSizedBufferVT 

func (m *Documentation) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Documentation) MarshalToVT 

func (m *Documentation) MarshalToVT(dAtA []byte) (int, error)

func (*Documentation) MarshalVT 

func (m *Documentation) MarshalVT() (dAtA []byte, err error)

func (*Documentation) ProtoMessage 

func (*Documentation) ProtoMessage()

func (*Documentation) Reset 

func (x *Documentation) Reset()

func (*Documentation) SizeVT 

func (m *Documentation) SizeVT() (n int)

func (*Documentation) String 

func (x *Documentation) String() string

func (*Documentation) UnmarshalJSON 

func (x *Documentation) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Documentation from JSON.

func (*Documentation) UnmarshalProtoJSON 

func (x *Documentation) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Documentation message from JSON.

func (*Documentation) UnmarshalVT 

func (m *Documentation) UnmarshalVT(dAtA []byte) error

type InitNotebookOp 

type InitNotebookOp struct {

	// NotebookObjectKey is the world object key for the notebook.
	NotebookObjectKey string `protobuf:"bytes,1,opt,name=notebook_object_key,json=notebookObjectKey,proto3" json:"notebookObjectKey,omitempty"`
	// UnixfsObjectKey is the world object key for the UnixFS storage.
	UnixfsObjectKey string `protobuf:"bytes,2,opt,name=unixfs_object_key,json=unixfsObjectKey,proto3" json:"unixfsObjectKey,omitempty"`
	// Timestamp is the creation timestamp.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

InitNotebookOp creates a Notebook with a UnixFS source and starter notes.

func (*InitNotebookOp) CloneMessageVT 

func (m *InitNotebookOp) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*InitNotebookOp) CloneVT 

func (m *InitNotebookOp) CloneVT() *InitNotebookOp

func (*InitNotebookOp) EqualMessageVT 

func (this *InitNotebookOp) EqualMessageVT(thatMsg any) bool

func (*InitNotebookOp) EqualVT 

func (this *InitNotebookOp) EqualVT(that *InitNotebookOp) bool

func (*InitNotebookOp) GetNotebookObjectKey 

func (x *InitNotebookOp) GetNotebookObjectKey() string

func (*InitNotebookOp) GetTimestamp 

func (x *InitNotebookOp) GetTimestamp() *timestamppb.Timestamp

func (*InitNotebookOp) GetUnixfsObjectKey 

func (x *InitNotebookOp) GetUnixfsObjectKey() string

func (*InitNotebookOp) MarshalJSON 

func (x *InitNotebookOp) MarshalJSON() ([]byte, error)

MarshalJSON marshals the InitNotebookOp to JSON.

func (*InitNotebookOp) MarshalProtoJSON 

func (x *InitNotebookOp) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the InitNotebookOp message to JSON.

func (*InitNotebookOp) MarshalProtoText 

func (x *InitNotebookOp) MarshalProtoText() string

func (*InitNotebookOp) MarshalToSizedBufferVT 

func (m *InitNotebookOp) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*InitNotebookOp) MarshalToVT 

func (m *InitNotebookOp) MarshalToVT(dAtA []byte) (int, error)

func (*InitNotebookOp) MarshalVT 

func (m *InitNotebookOp) MarshalVT() (dAtA []byte, err error)

func (*InitNotebookOp) ProtoMessage 

func (*InitNotebookOp) ProtoMessage()

func (*InitNotebookOp) Reset 

func (x *InitNotebookOp) Reset()

func (*InitNotebookOp) SizeVT 

func (m *InitNotebookOp) SizeVT() (n int)

func (*InitNotebookOp) String 

func (x *InitNotebookOp) String() string

func (*InitNotebookOp) UnmarshalJSON 

func (x *InitNotebookOp) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the InitNotebookOp from JSON.

func (*InitNotebookOp) UnmarshalProtoJSON 

func (x *InitNotebookOp) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the InitNotebookOp message from JSON.

func (*InitNotebookOp) UnmarshalVT 

func (m *InitNotebookOp) UnmarshalVT(dAtA []byte) error

type Notebook 

type Notebook struct {

	// Name is the display name of the notebook.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Sources is the ordered list of content sources.
	Sources []*NotebookSource `protobuf:"bytes,2,rep,name=sources,proto3" json:"sources,omitempty"`
	// contains filtered or unexported fields
}

Notebook is a world object that curates markdown files from UnixFS sources into a note-browsing experience.

func (*Notebook) CloneMessageVT 

func (m *Notebook) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Notebook) CloneVT 

func (m *Notebook) CloneVT() *Notebook

func (*Notebook) EqualMessageVT 

func (this *Notebook) EqualMessageVT(thatMsg any) bool

func (*Notebook) EqualVT 

func (this *Notebook) EqualVT(that *Notebook) bool

func (*Notebook) GetName 

func (x *Notebook) GetName() string

func (*Notebook) GetSources 

func (x *Notebook) GetSources() []*NotebookSource

func (*Notebook) MarshalJSON 

func (x *Notebook) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Notebook to JSON.

func (*Notebook) MarshalProtoJSON 

func (x *Notebook) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Notebook message to JSON.

func (*Notebook) MarshalProtoText 

func (x *Notebook) MarshalProtoText() string

func (*Notebook) MarshalToSizedBufferVT 

func (m *Notebook) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Notebook) MarshalToVT 

func (m *Notebook) MarshalToVT(dAtA []byte) (int, error)

func (*Notebook) MarshalVT 

func (m *Notebook) MarshalVT() (dAtA []byte, err error)

func (*Notebook) ProtoMessage 

func (*Notebook) ProtoMessage()

func (*Notebook) Reset 

func (x *Notebook) Reset()

func (*Notebook) SizeVT 

func (m *Notebook) SizeVT() (n int)

func (*Notebook) String 

func (x *Notebook) String() string

func (*Notebook) UnmarshalJSON 

func (x *Notebook) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Notebook from JSON.

func (*Notebook) UnmarshalProtoJSON 

func (x *Notebook) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Notebook message from JSON.

func (*Notebook) UnmarshalVT 

func (m *Notebook) UnmarshalVT(dAtA []byte) error

type NotebookSource 

type NotebookSource struct {

	// Name is the display name for this source in the sidebar.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Ref is a UnixFS path reference (object-uri format: key/-/path).
	Ref string `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// contains filtered or unexported fields
}

NotebookSource is a reference to a UnixFS path.

func (*NotebookSource) CloneMessageVT 

func (m *NotebookSource) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*NotebookSource) CloneVT 

func (m *NotebookSource) CloneVT() *NotebookSource

func (*NotebookSource) EqualMessageVT 

func (this *NotebookSource) EqualMessageVT(thatMsg any) bool

func (*NotebookSource) EqualVT 

func (this *NotebookSource) EqualVT(that *NotebookSource) bool

func (*NotebookSource) GetName 

func (x *NotebookSource) GetName() string

func (*NotebookSource) GetRef 

func (x *NotebookSource) GetRef() string

func (*NotebookSource) MarshalJSON 

func (x *NotebookSource) MarshalJSON() ([]byte, error)

MarshalJSON marshals the NotebookSource to JSON.

func (*NotebookSource) MarshalProtoJSON 

func (x *NotebookSource) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the NotebookSource message to JSON.

func (*NotebookSource) MarshalProtoText 

func (x *NotebookSource) MarshalProtoText() string

func (*NotebookSource) MarshalToSizedBufferVT 

func (m *NotebookSource) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*NotebookSource) MarshalToVT 

func (m *NotebookSource) MarshalToVT(dAtA []byte) (int, error)

func (*NotebookSource) MarshalVT 

func (m *NotebookSource) MarshalVT() (dAtA []byte, err error)

func (*NotebookSource) ProtoMessage 

func (*NotebookSource) ProtoMessage()

func (*NotebookSource) Reset 

func (x *NotebookSource) Reset()

func (*NotebookSource) SizeVT 

func (m *NotebookSource) SizeVT() (n int)

func (*NotebookSource) String 

func (x *NotebookSource) String() string

func (*NotebookSource) UnmarshalJSON 

func (x *NotebookSource) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the NotebookSource from JSON.

func (*NotebookSource) UnmarshalProtoJSON 

func (x *NotebookSource) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the NotebookSource message from JSON.

func (*NotebookSource) UnmarshalVT 

func (m *NotebookSource) UnmarshalVT(dAtA []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.