Struct flexbuffers::BuilderOptions

pub struct BuilderOptions { /* fields omitted */ }

Options for sharing data within a flexbuffer.

These increase serialization time but decrease the size of the resulting buffer. By default, SHARE_KEYS. You may wish to turn on SHARE_STRINGS if you know your data has many duplicate strings or SHARE_KEY_VECTORS if your data has many maps with identical keys.

Not Yet Implemented

• SHARE_STRINGS
• SHARE_KEY_VECTORS

Implementations

impl BuilderOptions

pub const SHARE_NONE: BuilderOptions

pub const SHARE_KEYS: BuilderOptions

pub const SHARE_STRINGS: BuilderOptions

pub const SHARE_KEYS_AND_STRINGS: BuilderOptions

pub const SHARE_KEY_VECTORS: BuilderOptions

pub const SHARE_ALL: BuilderOptions

pub const fn empty() -> BuilderOptions

Returns an empty set of flags

pub const fn all() -> BuilderOptions

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<BuilderOptions>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> BuilderOptions

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> BuilderOptions

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: BuilderOptions) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: BuilderOptions) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: BuilderOptions)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: BuilderOptions)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: BuilderOptions)

Toggles the specified flags in-place.

pub fn set(&mut self, other: BuilderOptions, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for BuilderOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl BitAnd<BuilderOptions> for BuilderOptions

type Output = BuilderOptions

The resulting type after applying the & operator.

fn bitand(self, other: BuilderOptions) -> BuilderOptions

Returns the intersection between the two sets of flags.

impl BitAndAssign<BuilderOptions> for BuilderOptions

fn bitand_assign(&mut self, other: BuilderOptions)

Disables all flags disabled in the set.

impl BitOr<BuilderOptions> for BuilderOptions

type Output = BuilderOptions

The resulting type after applying the | operator.

fn bitor(self, other: BuilderOptions) -> BuilderOptions

Returns the union of the two sets of flags.

impl BitOrAssign<BuilderOptions> for BuilderOptions

fn bitor_assign(&mut self, other: BuilderOptions)

Adds the set of flags.

impl BitXor<BuilderOptions> for BuilderOptions

type Output = BuilderOptions

The resulting type after applying the ^ operator.

fn bitxor(self, other: BuilderOptions) -> BuilderOptions

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<BuilderOptions> for BuilderOptions

fn bitxor_assign(&mut self, other: BuilderOptions)

Toggles the set of flags.

impl Clone for BuilderOptions

fn clone(&self) -> BuilderOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BuilderOptions

impl Debug for BuilderOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for BuilderOptions

fn default() -> Self

Returns the "default value" for a type.

impl Eq for BuilderOptions

impl Extend<BuilderOptions> for BuilderOptions

fn extend<T: IntoIterator<Item = BuilderOptions>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<BuilderOptions> for BuilderOptions

fn from_iter<T: IntoIterator<Item = BuilderOptions>>(
    iterator: T
) -> BuilderOptions

Creates a value from an iterator.

impl Hash for BuilderOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for BuilderOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Not for BuilderOptions

type Output = BuilderOptions

The resulting type after applying the ! operator.

fn not(self) -> BuilderOptions

Returns the complement of this set of flags.

impl Octal for BuilderOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Ord for BuilderOptions

fn cmp(&self, other: &BuilderOptions) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<BuilderOptions> for BuilderOptions

fn eq(&self, other: &BuilderOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BuilderOptions) -> bool

This method tests for !=.

impl PartialOrd<BuilderOptions> for BuilderOptions

fn partial_cmp(&self, other: &BuilderOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &BuilderOptions) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &BuilderOptions) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &BuilderOptions) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &BuilderOptions) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for BuilderOptions

impl StructuralPartialEq for BuilderOptions

impl Sub<BuilderOptions> for BuilderOptions

type Output = BuilderOptions

The resulting type after applying the - operator.

fn sub(self, other: BuilderOptions) -> BuilderOptions

Returns the set difference of the two sets of flags.

impl SubAssign<BuilderOptions> for BuilderOptions

fn sub_assign(&mut self, other: BuilderOptions)

Disables all flags enabled in the set.

impl UpperHex for BuilderOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.