common

package module
v0.0.0-...-7d73fae Latest Latest
Warning

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

Go to latest
Published: Jun 6, 2024 License: MPL-2.0 Imports: 7 Imported by: 16

Documentation

Index

Constants

View Source
const IdInformation_TypeID = 0xd4cb7ecbfe03dad3

IdInformation_TypeID is the unique identifier for the type IdInformation.

View Source
const Identifiable_TypeID = 0xb2afd1cb599c48d5

Identifiable_TypeID is the unique identifier for the type Identifiable.

View Source
const Identifiable_info_Params_TypeID = 0x9d8aa1cf1e49deb1

Identifiable_info_Params_TypeID is the unique identifier for the type Identifiable_info_Params.

View Source
const Pair_TypeID = 0xb9d4864725174733

Pair_TypeID is the unique identifier for the type Pair.

View Source
const StructuredText_TypeID = 0xed6c098b67cad454

StructuredText_TypeID is the unique identifier for the type StructuredText.

Variables

This section is empty.

Functions

func Identifiable_Methods

func Identifiable_Methods(methods []server.Method, s Identifiable_Server) []server.Method

Identifiable_Methods appends Methods to a slice that invoke the methods on s. This can be used to create a more complicated Server.

func Identifiable_NewServer

func Identifiable_NewServer(s Identifiable_Server) *server.Server

Identifiable_NewServer creates a new Server from an implementation of Identifiable_Server.

func RegisterSchema

func RegisterSchema(reg *schemas.Registry)

Types

type IdInformation

type IdInformation capnp.Struct

func NewIdInformation

func NewIdInformation(s *capnp.Segment) (IdInformation, error)

func NewRootIdInformation

func NewRootIdInformation(s *capnp.Segment) (IdInformation, error)

func ReadRootIdInformation

func ReadRootIdInformation(msg *capnp.Message) (IdInformation, error)

func (IdInformation) DecodeFromPtr

func (IdInformation) DecodeFromPtr(p capnp.Ptr) IdInformation

func (IdInformation) Description

func (s IdInformation) Description() (string, error)

func (IdInformation) DescriptionBytes

func (s IdInformation) DescriptionBytes() ([]byte, error)

func (IdInformation) EncodeAsPtr

func (s IdInformation) EncodeAsPtr(seg *capnp.Segment) capnp.Ptr

func (IdInformation) HasDescription

func (s IdInformation) HasDescription() bool

func (IdInformation) HasId

func (s IdInformation) HasId() bool

func (IdInformation) HasName

func (s IdInformation) HasName() bool

func (IdInformation) Id

func (s IdInformation) Id() (string, error)

func (IdInformation) IdBytes

func (s IdInformation) IdBytes() ([]byte, error)

func (IdInformation) IsValid

func (s IdInformation) IsValid() bool

func (IdInformation) Message

func (s IdInformation) Message() *capnp.Message

func (IdInformation) Name

func (s IdInformation) Name() (string, error)

func (IdInformation) NameBytes

func (s IdInformation) NameBytes() ([]byte, error)

func (IdInformation) Segment

func (s IdInformation) Segment() *capnp.Segment

func (IdInformation) SetDescription

func (s IdInformation) SetDescription(v string) error

func (IdInformation) SetId

func (s IdInformation) SetId(v string) error

func (IdInformation) SetName

func (s IdInformation) SetName(v string) error

func (IdInformation) String

func (s IdInformation) String() string

func (IdInformation) ToPtr

func (s IdInformation) ToPtr() capnp.Ptr

type IdInformation_Future

type IdInformation_Future struct{ *capnp.Future }

IdInformation_Future is a wrapper for a IdInformation promised by a client call.

func (IdInformation_Future) Struct

type IdInformation_List

type IdInformation_List = capnp.StructList[IdInformation]

IdInformation_List is a list of IdInformation.

func NewIdInformation_List

func NewIdInformation_List(s *capnp.Segment, sz int32) (IdInformation_List, error)

NewIdInformation creates a new list of IdInformation.

type Identifiable

type Identifiable capnp.Client

func Identifiable_ServerToClient

func Identifiable_ServerToClient(s Identifiable_Server) Identifiable

Identifiable_ServerToClient creates a new Client from an implementation of Identifiable_Server. The caller is responsible for calling Release on the returned Client.

func (Identifiable) AddRef

func (c Identifiable) AddRef() Identifiable

AddRef creates a new Client that refers to the same capability as c. If c is nil or has resolved to null, then AddRef returns nil.

func (Identifiable) DecodeFromPtr

func (Identifiable) DecodeFromPtr(p capnp.Ptr) Identifiable

func (Identifiable) EncodeAsPtr

func (c Identifiable) EncodeAsPtr(seg *capnp.Segment) capnp.Ptr

func (Identifiable) GetFlowLimiter

func (c Identifiable) GetFlowLimiter() fc.FlowLimiter

Get the current flowcontrol.FlowLimiter used to manage flow control for this client.

func (Identifiable) Info

func (Identifiable) IsSame

func (c Identifiable) IsSame(other Identifiable) bool

IsSame reports whether c and other refer to a capability created by the same call to NewClient. This can return false negatives if c or other are not fully resolved: use Resolve if this is an issue. If either c or other are released, then IsSame panics.

func (Identifiable) IsValid

func (c Identifiable) IsValid() bool

IsValid reports whether c is a valid reference to a capability. A reference is invalid if it is nil, has resolved to null, or has been released.

func (Identifiable) Release

func (c Identifiable) Release()

Release releases a capability reference. If this is the last reference to the capability, then the underlying resources associated with the capability will be released.

Release will panic if c has already been released, but not if c is nil or resolved to null.

func (Identifiable) Resolve

func (c Identifiable) Resolve(ctx context.Context) error

Resolve blocks until the capability is fully resolved or the Context expires.

func (Identifiable) SetFlowLimiter

func (c Identifiable) SetFlowLimiter(lim fc.FlowLimiter)

Update the flowcontrol.FlowLimiter used to manage flow control for this client. This affects all future calls, but not calls already waiting to send. Passing nil sets the value to flowcontrol.NopLimiter, which is also the default.

func (Identifiable) String

func (c Identifiable) String() string

String returns a string that identifies this capability for debugging purposes. Its format should not be depended on: in particular, it should not be used to compare clients. Use IsSame to compare clients for equality.

func (Identifiable) WaitStreaming

func (c Identifiable) WaitStreaming() error

type Identifiable_List

type Identifiable_List = capnp.CapList[Identifiable]

Identifiable_List is a list of Identifiable.

func NewIdentifiable_List

func NewIdentifiable_List(s *capnp.Segment, sz int32) (Identifiable_List, error)

NewIdentifiable creates a new list of Identifiable.

type Identifiable_Server

type Identifiable_Server interface {
	Info(context.Context, Identifiable_info) error
}

A Identifiable_Server is a Identifiable with a local implementation.

type Identifiable_info

type Identifiable_info struct {
	*server.Call
}

Identifiable_info holds the state for a server call to Identifiable.info. See server.Call for documentation.

func (Identifiable_info) AllocResults

func (c Identifiable_info) AllocResults() (IdInformation, error)

AllocResults allocates the results struct.

func (Identifiable_info) Args

Args returns the call's arguments.

type Identifiable_info_Params

type Identifiable_info_Params capnp.Struct

func NewIdentifiable_info_Params

func NewIdentifiable_info_Params(s *capnp.Segment) (Identifiable_info_Params, error)

func NewRootIdentifiable_info_Params

func NewRootIdentifiable_info_Params(s *capnp.Segment) (Identifiable_info_Params, error)

func ReadRootIdentifiable_info_Params

func ReadRootIdentifiable_info_Params(msg *capnp.Message) (Identifiable_info_Params, error)

func (Identifiable_info_Params) DecodeFromPtr

func (Identifiable_info_Params) EncodeAsPtr

func (s Identifiable_info_Params) EncodeAsPtr(seg *capnp.Segment) capnp.Ptr

func (Identifiable_info_Params) IsValid

func (s Identifiable_info_Params) IsValid() bool

func (Identifiable_info_Params) Message

func (s Identifiable_info_Params) Message() *capnp.Message

func (Identifiable_info_Params) Segment

func (s Identifiable_info_Params) Segment() *capnp.Segment

func (Identifiable_info_Params) String

func (s Identifiable_info_Params) String() string

func (Identifiable_info_Params) ToPtr

type Identifiable_info_Params_Future

type Identifiable_info_Params_Future struct{ *capnp.Future }

Identifiable_info_Params_Future is a wrapper for a Identifiable_info_Params promised by a client call.

func (Identifiable_info_Params_Future) Struct

type Identifiable_info_Params_List

type Identifiable_info_Params_List = capnp.StructList[Identifiable_info_Params]

Identifiable_info_Params_List is a list of Identifiable_info_Params.

func NewIdentifiable_info_Params_List

func NewIdentifiable_info_Params_List(s *capnp.Segment, sz int32) (Identifiable_info_Params_List, error)

NewIdentifiable_info_Params creates a new list of Identifiable_info_Params.

type Pair

type Pair capnp.Struct

func NewPair

func NewPair(s *capnp.Segment) (Pair, error)

func NewRootPair

func NewRootPair(s *capnp.Segment) (Pair, error)

func ReadRootPair

func ReadRootPair(msg *capnp.Message) (Pair, error)

func (Pair) DecodeFromPtr

func (Pair) DecodeFromPtr(p capnp.Ptr) Pair

func (Pair) EncodeAsPtr

func (s Pair) EncodeAsPtr(seg *capnp.Segment) capnp.Ptr

func (Pair) Fst

func (s Pair) Fst() (capnp.Ptr, error)

func (Pair) HasFst

func (s Pair) HasFst() bool

func (Pair) HasSnd

func (s Pair) HasSnd() bool

func (Pair) IsValid

func (s Pair) IsValid() bool

func (Pair) Message

func (s Pair) Message() *capnp.Message

func (Pair) Segment

func (s Pair) Segment() *capnp.Segment

func (Pair) SetFst

func (s Pair) SetFst(v capnp.Ptr) error

func (Pair) SetSnd

func (s Pair) SetSnd(v capnp.Ptr) error

func (Pair) Snd

func (s Pair) Snd() (capnp.Ptr, error)

func (Pair) String

func (s Pair) String() string

func (Pair) ToPtr

func (s Pair) ToPtr() capnp.Ptr

type Pair_Future

type Pair_Future struct{ *capnp.Future }

Pair_Future is a wrapper for a Pair promised by a client call.

func (Pair_Future) Fst

func (p Pair_Future) Fst() *capnp.Future

func (Pair_Future) Snd

func (p Pair_Future) Snd() *capnp.Future

func (Pair_Future) Struct

func (f Pair_Future) Struct() (Pair, error)

type Pair_List

type Pair_List = capnp.StructList[Pair]

Pair_List is a list of Pair.

func NewPair_List

func NewPair_List(s *capnp.Segment, sz int32) (Pair_List, error)

NewPair creates a new list of Pair.

type StructuredText

type StructuredText capnp.Struct

func NewRootStructuredText

func NewRootStructuredText(s *capnp.Segment) (StructuredText, error)

func NewStructuredText

func NewStructuredText(s *capnp.Segment) (StructuredText, error)

func ReadRootStructuredText

func ReadRootStructuredText(msg *capnp.Message) (StructuredText, error)

func (StructuredText) DecodeFromPtr

func (StructuredText) DecodeFromPtr(p capnp.Ptr) StructuredText

func (StructuredText) EncodeAsPtr

func (s StructuredText) EncodeAsPtr(seg *capnp.Segment) capnp.Ptr

func (StructuredText) HasValue

func (s StructuredText) HasValue() bool

func (StructuredText) IsValid

func (s StructuredText) IsValid() bool

func (StructuredText) Message

func (s StructuredText) Message() *capnp.Message

func (StructuredText) Segment

func (s StructuredText) Segment() *capnp.Segment

func (StructuredText) SetValue

func (s StructuredText) SetValue(v string) error

func (StructuredText) String

func (s StructuredText) String() string

func (StructuredText) Structure

func (StructuredText) ToPtr

func (s StructuredText) ToPtr() capnp.Ptr

func (StructuredText) Value

func (s StructuredText) Value() (string, error)

func (StructuredText) ValueBytes

func (s StructuredText) ValueBytes() ([]byte, error)

type StructuredText_Future

type StructuredText_Future struct{ *capnp.Future }

StructuredText_Future is a wrapper for a StructuredText promised by a client call.

func (StructuredText_Future) Struct

func (StructuredText_Future) Structure

type StructuredText_List

type StructuredText_List = capnp.StructList[StructuredText]

StructuredText_List is a list of StructuredText.

func NewStructuredText_List

func NewStructuredText_List(s *capnp.Segment, sz int32) (StructuredText_List, error)

NewStructuredText creates a new list of StructuredText.

type StructuredText_structure

type StructuredText_structure StructuredText

func (StructuredText_structure) IsValid

func (s StructuredText_structure) IsValid() bool

func (StructuredText_structure) Message

func (s StructuredText_structure) Message() *capnp.Message

func (StructuredText_structure) Segment

func (s StructuredText_structure) Segment() *capnp.Segment

func (StructuredText_structure) SetJson

func (s StructuredText_structure) SetJson()

func (StructuredText_structure) SetNone

func (s StructuredText_structure) SetNone()

func (StructuredText_structure) SetXml

func (s StructuredText_structure) SetXml()

func (StructuredText_structure) Which

type StructuredText_structure_Future

type StructuredText_structure_Future struct{ *capnp.Future }

StructuredText_structure_Future is a wrapper for a StructuredText_structure promised by a client call.

func (StructuredText_structure_Future) Struct

type StructuredText_structure_Which

type StructuredText_structure_Which uint16
const (
	StructuredText_structure_Which_none StructuredText_structure_Which = 0
	StructuredText_structure_Which_json StructuredText_structure_Which = 1
	StructuredText_structure_Which_xml  StructuredText_structure_Which = 2
)

func (StructuredText_structure_Which) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL