Documentation
¶
Index ¶
- type BlockCursorResource
- func (r *BlockCursorResource) ClearAllRefs(ctx context.Context, req *s4wave_block_cursor.ClearAllRefsRequest) (*s4wave_block_cursor.ClearAllRefsResponse, error)
- func (r *BlockCursorResource) ClearRef(ctx context.Context, req *s4wave_block_cursor.ClearRefRequest) (*s4wave_block_cursor.ClearRefResponse, error)
- func (r *BlockCursorResource) Detach(ctx context.Context, req *s4wave_block_cursor.DetachRequest) (*s4wave_block_cursor.DetachResponse, error)
- func (r *BlockCursorResource) DetachRecursive(ctx context.Context, req *s4wave_block_cursor.DetachRecursiveRequest) (*s4wave_block_cursor.DetachRecursiveResponse, error)
- func (r *BlockCursorResource) DetachTransaction(ctx context.Context, req *s4wave_block_cursor.DetachTransactionRequest) (*s4wave_block_cursor.DetachTransactionResponse, error)
- func (r *BlockCursorResource) Fetch(ctx context.Context, req *s4wave_block_cursor.FetchRequest) (*s4wave_block_cursor.FetchResponse, error)
- func (r *BlockCursorResource) FollowRef(ctx context.Context, req *s4wave_block_cursor.FollowRefRequest) (*s4wave_block_cursor.FollowRefResponse, error)
- func (r *BlockCursorResource) FollowSubBlock(ctx context.Context, req *s4wave_block_cursor.FollowSubBlockRequest) (*s4wave_block_cursor.FollowSubBlockResponse, error)
- func (r *BlockCursorResource) GetAllRefs(ctx context.Context, req *s4wave_block_cursor.GetAllRefsRequest) (*s4wave_block_cursor.GetAllRefsResponse, error)
- func (r *BlockCursorResource) GetBlock(ctx context.Context, req *s4wave_block_cursor.GetBlockRequest) (*s4wave_block_cursor.GetBlockResponse, error)
- func (r *BlockCursorResource) GetExistingRef(ctx context.Context, req *s4wave_block_cursor.GetExistingRefRequest) (*s4wave_block_cursor.GetExistingRefResponse, error)
- func (r *BlockCursorResource) GetMux() srpc.Invoker
- func (r *BlockCursorResource) GetRef(ctx context.Context, req *s4wave_block_cursor.GetRefRequest) (*s4wave_block_cursor.GetRefResponse, error)
- func (r *BlockCursorResource) IsDirty(ctx context.Context, req *s4wave_block_cursor.IsDirtyRequest) (*s4wave_block_cursor.IsDirtyResponse, error)
- func (r *BlockCursorResource) IsSubBlock(ctx context.Context, req *s4wave_block_cursor.IsSubBlockRequest) (*s4wave_block_cursor.IsSubBlockResponse, error)
- func (r *BlockCursorResource) MarkDirty(ctx context.Context, req *s4wave_block_cursor.MarkDirtyRequest) (*s4wave_block_cursor.MarkDirtyResponse, error)
- func (r *BlockCursorResource) Parents(ctx context.Context, req *s4wave_block_cursor.ParentsRequest) (*s4wave_block_cursor.ParentsResponse, error)
- func (r *BlockCursorResource) SetAsSubBlock(ctx context.Context, req *s4wave_block_cursor.SetAsSubBlockRequest) (*s4wave_block_cursor.SetAsSubBlockResponse, error)
- func (r *BlockCursorResource) SetBlock(ctx context.Context, req *s4wave_block_cursor.SetBlockRequest) (*s4wave_block_cursor.SetBlockResponse, error)
- func (r *BlockCursorResource) SetRef(ctx context.Context, req *s4wave_block_cursor.SetRefRequest) (*s4wave_block_cursor.SetRefResponse, error)
- func (r *BlockCursorResource) Unmarshal(ctx context.Context, req *s4wave_block_cursor.UnmarshalRequest) (*s4wave_block_cursor.UnmarshalResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BlockCursorResource ¶
type BlockCursorResource struct {
// contains filtered or unexported fields
}
BlockCursorResource wraps a block.Cursor for resource access.
func NewBlockCursorResource ¶
func NewBlockCursorResource(le *logrus.Entry, b bus.Bus, tx *block.Transaction, cursor *block.Cursor) *BlockCursorResource
NewBlockCursorResource creates a new BlockCursorResource.
func (*BlockCursorResource) ClearAllRefs ¶
func (r *BlockCursorResource) ClearAllRefs(ctx context.Context, req *s4wave_block_cursor.ClearAllRefsRequest) (*s4wave_block_cursor.ClearAllRefsResponse, error)
ClearAllRefs clears all references.
func (*BlockCursorResource) ClearRef ¶
func (r *BlockCursorResource) ClearRef(ctx context.Context, req *s4wave_block_cursor.ClearRefRequest) (*s4wave_block_cursor.ClearRefResponse, error)
ClearRef removes the reference handle to the given ref ID.
func (*BlockCursorResource) Detach ¶
func (r *BlockCursorResource) Detach(ctx context.Context, req *s4wave_block_cursor.DetachRequest) (*s4wave_block_cursor.DetachResponse, error)
Detach clones the cursor position.
func (*BlockCursorResource) DetachRecursive ¶
func (r *BlockCursorResource) DetachRecursive(ctx context.Context, req *s4wave_block_cursor.DetachRecursiveRequest) (*s4wave_block_cursor.DetachRecursiveResponse, error)
DetachRecursive clones the cursor position and all referenced positions.
func (*BlockCursorResource) DetachTransaction ¶
func (r *BlockCursorResource) DetachTransaction(ctx context.Context, req *s4wave_block_cursor.DetachTransactionRequest) (*s4wave_block_cursor.DetachTransactionResponse, error)
DetachTransaction creates a new ephemeral transaction rooted at the cursor.
func (*BlockCursorResource) Fetch ¶
func (r *BlockCursorResource) Fetch(ctx context.Context, req *s4wave_block_cursor.FetchRequest) (*s4wave_block_cursor.FetchResponse, error)
Fetch fetches the raw block data at the current position.
func (*BlockCursorResource) FollowRef ¶
func (r *BlockCursorResource) FollowRef(ctx context.Context, req *s4wave_block_cursor.FollowRefRequest) (*s4wave_block_cursor.FollowRefResponse, error)
FollowRef follows a reference field and returns a new cursor.
func (*BlockCursorResource) FollowSubBlock ¶
func (r *BlockCursorResource) FollowSubBlock(ctx context.Context, req *s4wave_block_cursor.FollowSubBlockRequest) (*s4wave_block_cursor.FollowSubBlockResponse, error)
FollowSubBlock follows a sub-block reference and returns a new cursor.
func (*BlockCursorResource) GetAllRefs ¶
func (r *BlockCursorResource) GetAllRefs(ctx context.Context, req *s4wave_block_cursor.GetAllRefsRequest) (*s4wave_block_cursor.GetAllRefsResponse, error)
GetAllRefs returns cursors to all references.
func (*BlockCursorResource) GetBlock ¶
func (r *BlockCursorResource) GetBlock(ctx context.Context, req *s4wave_block_cursor.GetBlockRequest) (*s4wave_block_cursor.GetBlockResponse, error)
GetBlock returns the current loaded block at the position.
func (*BlockCursorResource) GetExistingRef ¶
func (r *BlockCursorResource) GetExistingRef(ctx context.Context, req *s4wave_block_cursor.GetExistingRefRequest) (*s4wave_block_cursor.GetExistingRefResponse, error)
GetExistingRef checks if the reference has been traversed already.
func (*BlockCursorResource) GetMux ¶
func (r *BlockCursorResource) GetMux() srpc.Invoker
GetMux returns the rpc mux.
func (*BlockCursorResource) GetRef ¶
func (r *BlockCursorResource) GetRef(ctx context.Context, req *s4wave_block_cursor.GetRefRequest) (*s4wave_block_cursor.GetRefResponse, error)
GetRef gets the current block reference.
func (*BlockCursorResource) IsDirty ¶
func (r *BlockCursorResource) IsDirty(ctx context.Context, req *s4wave_block_cursor.IsDirtyRequest) (*s4wave_block_cursor.IsDirtyResponse, error)
IsDirty checks if the cursor has uncommitted changes.
func (*BlockCursorResource) IsSubBlock ¶
func (r *BlockCursorResource) IsSubBlock(ctx context.Context, req *s4wave_block_cursor.IsSubBlockRequest) (*s4wave_block_cursor.IsSubBlockResponse, error)
IsSubBlock indicates if the cursor is at a sub-block position.
func (*BlockCursorResource) MarkDirty ¶
func (r *BlockCursorResource) MarkDirty(ctx context.Context, req *s4wave_block_cursor.MarkDirtyRequest) (*s4wave_block_cursor.MarkDirtyResponse, error)
MarkDirty marks the cursor location dirty for re-writing.
func (*BlockCursorResource) Parents ¶
func (r *BlockCursorResource) Parents(ctx context.Context, req *s4wave_block_cursor.ParentsRequest) (*s4wave_block_cursor.ParentsResponse, error)
Parents returns new cursors pointing to the parent blocks.
func (*BlockCursorResource) SetAsSubBlock ¶
func (r *BlockCursorResource) SetAsSubBlock(ctx context.Context, req *s4wave_block_cursor.SetAsSubBlockRequest) (*s4wave_block_cursor.SetAsSubBlockResponse, error)
SetAsSubBlock sets the cursor position as a sub-block of another block.
func (*BlockCursorResource) SetBlock ¶
func (r *BlockCursorResource) SetBlock(ctx context.Context, req *s4wave_block_cursor.SetBlockRequest) (*s4wave_block_cursor.SetBlockResponse, error)
SetBlock sets the block at the current position.
func (*BlockCursorResource) SetRef ¶
func (r *BlockCursorResource) SetRef(ctx context.Context, req *s4wave_block_cursor.SetRefRequest) (*s4wave_block_cursor.SetRefResponse, error)
SetRef sets a block reference to the handle at the cursor.
func (*BlockCursorResource) Unmarshal ¶
func (r *BlockCursorResource) Unmarshal(ctx context.Context, req *s4wave_block_cursor.UnmarshalRequest) (*s4wave_block_cursor.UnmarshalResponse, error)
Unmarshal fetches and unmarshals the data to a block.