streamvisitor

type EOFCallback ¶

type EOFCallback func() error

type InvalidTransitionCallback ¶

type InvalidTransitionCallback func(from, to protoreflect.FieldNumber, allowed []protoreflect.FieldNumber, message proto.Message) error

InvalidTransitionCallback is a callback that is called when an invalid transition is attempted. 'message' is nil when 'to' is eofState.

type MessageCallback ¶

type MessageCallback any

MessageCallback is a function with signature func(message someConcreteProtoMessage) error someConcreteProtoMessage must be the type passed to NewStreamVisitor().

type Stream ¶

type Stream interface {
	RecvMsg(m any) error
}

Stream is a grpc.ServerStream or grpc.ClientStream.

type StreamVisitor ¶

type StreamVisitor struct {
	// contains filtered or unexported fields
}

StreamVisitor allows to consume messages in a gRPC stream. Message order should follow the automata, defined on fields in a oneof group.

func NewStreamVisitor(streamMessage proto.Message) (*StreamVisitor, error)

func (s *StreamVisitor) Visit(stream Stream, opts ...StreamVisitorOption) error

type StreamVisitorOption ¶

type StreamVisitorOption func(*svConfig) error

StreamVisitorOption is an option for the visitor. Must return nil or an error, compatible with the gRPC status package.

func WithCallback(transitionTo protoreflect.FieldNumber, cb MessageCallback) StreamVisitorOption

func WithEOFCallback(cb EOFCallback) StreamVisitorOption

func WithNotExpectingToGet(code codes.Code, transitionTo ...protoreflect.FieldNumber) StreamVisitorOption

func WithStartState(startState protoreflect.FieldNumber) StreamVisitorOption