Struct amplify::flags::FlagVec

pub struct FlagVec(/* private fields */);

Bit flag vector. Can hold up to 2^16-1 flags and guaranteed to have length up to 255 bytes.

Implementations

impl FlagVec

pub fn new() -> FlagVec

Constructs a features vector of zero feature flag set

pub fn with_capacity(upto: FlagNo) -> Self

Constructs a features vector of upto feature flag in unset state

pub fn is_empty(&self) -> bool

Detects whether structure contains any flags set

pub fn count_flags(&self) -> u16

Counts number of flags set

pub fn as_slice(&self) -> &[u8]

Returns byte slice representation of the inner data

pub fn to_vec(&self) -> Vec<u8>

Returns inner byte vector containing all flags

pub fn into_vec(self) -> Vec<u8>

Returns inner byte vector containing all flags

pub fn from_inner(vec: TinyVec<u8>) -> Self

Constructs flags from the inner representation in form of TinyVec.

pub fn as_inner(&mut self) -> &TinyVec<u8>

Returns byte slice representation of the inner TinyVec.

Shrinks the inner data.

pub fn to_inner(&self) -> TinyVec<u8>

Returns byte slice representation of the inner TinyVec

pub fn into_inner(self) -> TinyVec<u8>

Returns byte slice representation of the inner TinyVec

pub fn shrunk(&self) -> Self

Returns a shrunk copy of the self

pub fn iter(&self) -> AllSet<'_>

Creates an iterator for the current feature flags which have “set” state

pub fn known_iter(&self, known: FlagVec) -> FilteredIter<'_>

Creates iterator over known set of the features

pub fn unknown_iter(&self, known: FlagVec) -> FilteredIter<'_>

Creates iterator over unknown set of the features, i.e. features that do not match flags set in known parameter

pub fn shrink(&mut self) -> bool

Reduces the size of the internal buffer to the smallest capacity required to keep all currently set feature flags. Returns true if resize operation was required, or false otherwise, when the internal buffer already was of the smallest possible size

pub fn is_set(&self, flag_no: FlagNo) -> bool

Returns whether a feature flag with flag_no is set (true or false)

pub fn set(&mut self, flag_no: FlagNo) -> bool

Sets the feature flag with number flag_no. Returns true if the flag was already set and false otherwise (i.e. previous value of the flag)

pub fn unset(&mut self, flag_no: FlagNo) -> bool

Unsets the feature flag with number flag_no. Returns true if the flag was set before and false otherwise (i.e. previous value of the flag)

pub fn invert(&mut self, flag_no: FlagNo)

Inverts the feature flag with number flag_no

Trait Implementations

impl Binary for FlagVec

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

Formats the value using the given formatter.

impl BitAnd for FlagVec

type Output = FlagVec

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for FlagVec

type Output = FlagVec

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for FlagVec

type Output = FlagVec

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for FlagVec

fn clone(&self) -> FlagVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlagVec

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

Formats the value using the given formatter.

impl Default for FlagVec

fn default() -> Self

Returns the “default value” for a type.

impl Display for FlagVec

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

Formats the value using the given formatter.

impl FromStr for FlagVec

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FlagVec

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for FlagVec

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

Formats the value using the given formatter.

impl Octal for FlagVec

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

Formats the value using the given formatter.

impl Ord for FlagVec

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FlagVec

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FlagVec

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

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

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

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

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

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

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

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

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

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

impl TryFrom<&[u8]> for FlagVec

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for FlagVec

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for FlagVec

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

Formats the value using the given formatter.

impl Eq for FlagVec