Struct capnp::message::Builder

pub struct Builder<A>where
    A: Allocator,{ /* private fields */ }

A container used to build a message.

Implementations

impl<A> Builder<A>where
    A: Allocator,

pub fn new(allocator: A) -> Self

pub fn init_root<'a, T: FromPointerBuilder<'a>>(&'a mut self) -> T

Initializes the root as a value of the given type.

pub fn get_root<'a, T: FromPointerBuilder<'a>>(&'a mut self) -> Result<T>

Gets the root, interpreting it as the given type.

pub fn get_root_as_reader<'a, T: FromPointerReader<'a>>(&'a self) -> Result<T>

pub fn set_root<From: SetPointerBuilder>(&mut self, value: From) -> Result<()>

Sets the root to a deep copy of the given value.

pub fn set_root_canonical<From: SetPointerBuilder>(
    &mut self,
    value: From
) -> Result<()>

Sets the root to a canonicalized version of value. If this was the first action taken on this Builder, then a subsequent call to get_segments_for_output() should return a single segment, containing the full canonicalized message.

pub fn get_segments_for_output(&self) -> OutputSegments<'_>

pub fn into_reader(self) -> Reader<Self>

pub fn into_typed<T: Owned>(self) -> TypedBuilder<T, A>

pub fn into_allocator(self) -> A

Retrieves the underlying Allocator, deallocating all currently-allocated segments.

impl Builder<HeapAllocator>

pub fn new_default() -> Self

Constructs a new message::Builder<HeapAllocator> whose first segment has length SUGGESTED_FIRST_SEGMENT_WORDS.

Trait Implementations

impl<T, A> From<Builder<A>> for TypedBuilder<T, A>where
    T: Owned,
    A: Allocator,

fn from(builder: Builder<A>) -> Self

Converts to this type from the input type.

impl<A, T> From<Builder<A>> for TypedReader<Builder<A>, T>where
    A: Allocator,
    T: Owned,

fn from(message: Builder<A>) -> Self

Converts to this type from the input type.

impl<A> ReaderSegments for Builder<A>where
    A: Allocator,

fn get_segment(&self, id: u32) -> Option<&[u8]>

Gets the segment with index idx. Returns None if idx is out of range.

fn len(&self) -> usize

Gets the number of segments.

fn is_empty(&self) -> bool

impl<A> Send for Builder<A>where
    A: Send + Allocator,