Struct Builder

pub struct Builder<S, T: MutableData> { /* private fields */ }

Builder provides a low-level wire protocol builder object. This is generic over buffer types and uses type-state mutation to ensure created objects are valid

Implementations

impl<S, T: MutableData> Builder<S, T>

pub fn id(self, id: &Id) -> Self

Set the object id

pub fn header_mut(&mut self) -> WireHeader<&mut [u8]>

Fetch a mutable instance of the object header

impl<T: MutableData> Builder<Init, T>

pub fn new(buf: T) -> Self

Create a new base builder object

pub fn header(self, header: &Header) -> Self

Set the object header. Note that length fields will be overwritten by actual lengths

pub fn body<B: ImmutableData>( self, body: &NewBody<B>, secret_key: Option<&SecretKey>, ) -> Result<Builder<SetPrivateOptions, T>, Error>

Add body data, mutating the state of the builder

impl<T: MutableData> Builder<SetPrivateOptions, T>

pub fn private_options<C: AsRef<[Options]>, E: ImmutableData>( self, options: &OptionsList<C, E>, secret_key: Option<&SecretKey>, ) -> Result<Builder<SetPublicOptions, T>, Error>

Encode private options This must be done in one pass as the entire options block is encrypted

impl<T: MutableData> Builder<SetPublicOptions, T>

pub fn public_options<C: AsRef<[Options]>, E: ImmutableData>( self, options: &OptionsList<C, E>, ) -> Result<Builder<SetPublicOptions, T>, Error>

Encode a list of public options

pub fn public_option(&mut self, option: &Options) -> Result<(), Error>

Add a single public option

pub fn sign(self, signing_key: &PrivateKey) -> Result<Container<T>, Error>