Skip to main content

GenericDatumWriterBuilder

Struct GenericDatumWriterBuilder 

Source
pub struct GenericDatumWriterBuilder<'s, S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<'s, S: State> GenericDatumWriterBuilder<'s, S>

Source

pub fn build(self) -> AvroResult<GenericDatumWriter<'s>>
where S: IsComplete,

Finishes building and performs the requested action.

Source

pub fn resolved_schemata( self, value: ResolvedSchema<'s>, ) -> GenericDatumWriterBuilder<'s, SetResolvedSchemata<S>>
where S::ResolvedSchemata: IsUnset,

Optional (Some / Option setters). Already resolved schemata that will be used to resolve references in the writer’s schema.

You can also use Self::schemata instead.

Source

pub fn maybe_resolved_schemata( self, value: Option<ResolvedSchema<'s>>, ) -> GenericDatumWriterBuilder<'s, SetResolvedSchemata<S>>
where S::ResolvedSchemata: IsUnset,

Optional (Some / Option setters). Already resolved schemata that will be used to resolve references in the writer’s schema.

You can also use Self::schemata instead.

Source

pub fn validate( self, value: bool, ) -> GenericDatumWriterBuilder<'s, SetValidate<S>>
where S::Validate: IsUnset,

Optional (Some / Option setters). Default: true.

Validate values against the writer schema before writing them.

Defaults to true.

Setting this to false and writing values that don’t match the schema will make the written data unreadable.

Source

pub fn maybe_validate( self, value: Option<bool>, ) -> GenericDatumWriterBuilder<'s, SetValidate<S>>
where S::Validate: IsUnset,

Optional (Some / Option setters). Default: true.

Validate values against the writer schema before writing them.

Defaults to true.

Setting this to false and writing values that don’t match the schema will make the written data unreadable.

Source

pub fn target_block_size( self, value: usize, ) -> GenericDatumWriterBuilder<'s, SetTargetBlockSize<S>>
where S::TargetBlockSize: IsUnset,

Optional (Some / Option setters). At what block size to start a new block (for arrays and maps).

This is a minimum value, the block size will always be larger than this except for the last block.

When set to None all values will be written in a single block. This can be faster as no intermediate buffer is used, but seeking through written data will be slower.

Source

pub fn maybe_target_block_size( self, value: Option<usize>, ) -> GenericDatumWriterBuilder<'s, SetTargetBlockSize<S>>
where S::TargetBlockSize: IsUnset,

Optional (Some / Option setters). At what block size to start a new block (for arrays and maps).

This is a minimum value, the block size will always be larger than this except for the last block.

When set to None all values will be written in a single block. This can be faster as no intermediate buffer is used, but seeking through written data will be slower.

Source

pub fn human_readable( self, value: bool, ) -> GenericDatumWriterBuilder<'s, SetHumanReadable<S>>
where S::HumanReadable: IsUnset,

Optional (Some / Option setters). Default: is_human_readable().

Should Serialize implementations pick a human readable representation.

It is recommended to set this to false.

Source

pub fn maybe_human_readable( self, value: Option<bool>, ) -> GenericDatumWriterBuilder<'s, SetHumanReadable<S>>
where S::HumanReadable: IsUnset,

Optional (Some / Option setters). Default: is_human_readable().

Should Serialize implementations pick a human readable representation.

It is recommended to set this to false.

Source§

impl<'s, S: State> GenericDatumWriterBuilder<'s, S>

Source

pub fn schemata( self, schemata: Vec<&'s Schema>, ) -> AvroResult<GenericDatumWriterBuilder<'s, SetResolvedSchemata<S>>>
where S::ResolvedSchemata: IsUnset,

Set the schemata that will be used to resolve any references in the schema.

This is equivalent to .resolved_schemata(ResolvedSchema::new_with_schemata(schemata)?). If you already have a ResolvedSchema, use that function instead.

Auto Trait Implementations§

§

impl<'s, S> Freeze for GenericDatumWriterBuilder<'s, S>

§

impl<'s, S> RefUnwindSafe for GenericDatumWriterBuilder<'s, S>

§

impl<'s, S> Send for GenericDatumWriterBuilder<'s, S>

§

impl<'s, S> Sync for GenericDatumWriterBuilder<'s, S>

§

impl<'s, S> Unpin for GenericDatumWriterBuilder<'s, S>

§

impl<'s, S> UnsafeUnpin for GenericDatumWriterBuilder<'s, S>

§

impl<'s, S> UnwindSafe for GenericDatumWriterBuilder<'s, S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.