Struct Layout

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

Inline memory layout for raw block.

Implementations

impl Layout

pub const WITH_TABLE_NAME: Self

With table name in the block.

pub const WITH_FIELD_NAMES: Self

With field names.

pub const WITH_GROUP_ID: Self

If raw data block contains group id.

pub const WITH_FIELD_SCHEMA: Self

If raw data contains schema

pub const NCHAR_IS_DECODED: Self

If NChar decoded or not in data block.

pub const SCHEMA_CHANGED: Self

If Schema has been changed, eg. subset or added some columns.

pub const INLINE_DEFAULT: Self

Inline with full raw layout, this is the default behavior.

+-----+----+----+-----+------+---+---+------+-------+------------+
|flags|rows|cols|table|fields|len|gid|schema|lengths|    data    |
+-----+----+----+-----+------+---+---+------+-------+------------+
|2    |4   |4   | dyn | dyn  | 4 | 8 |cols*6|cols*4 |sum(lengths)|
+-----+----+----+-----+------+---+---+------+-------+------------+

pub const INLINE_AS_RAW_BLOCK: Self

Inline as raw block only, without table names and field names.

+-----+----+----+---+---+------+-------+------------+
|flags|rows|cols|len|gid|schema|lengths|    data    |
+-----+----+----+---+---+------+-------+------------+
|2    |4   |4   |4  | 8 |cols*6|cols*4 |sum(lengths)|
+-----+----+----+---+---+------+-------+------------+

pub const INLINE_AS_DATA_ONLY: Self

Inline as data only to save space.

+-----+----+----+-------+------------|
|flags|rows|cols|lengths|    data    |
+-----+----+----+-------+------------|
|2    |4   |4   |cols*4 |sum(lengths)|
+-----+----+----+-------+------------|

pub const PRECISION_MASK: Self

Precision mask.

pub const PRECISION_CLEAR_MASK: Self

pub const IS_MILLIS: Self

pub const IS_MICROS: Self

pub const IS_NANOS: Self

pub const FORMAT_MASK: Self

pub const IS_RAW_DATA: Self

is raw data

pub const IS_RAW_META: Self

is raw meta

pub const IS_STB_DATA: Self

Is STable data, contains sql schema and table name - tags map.

pub const IS_HEADER: Self

Is database schema, used for database rebuild.

impl Layout

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Layout

pub const fn iter(&self) -> Iter<Layout>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Layout>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl Layout

pub fn precision(&self) -> Precision

pub fn expect_table_name(&self) -> bool

pub fn with_table_name(&mut self) -> &mut Self

pub fn expect_field_names(&self) -> bool

pub fn with_field_names(&mut self) -> &mut Self

pub fn nchar_is_decoded(&self) -> bool

pub fn with_nchar_decoded(&mut self) -> &mut Self

pub fn with_precision(&mut self, precision: Precision) -> &mut Self

pub fn with_schema_changed(self) -> Self

pub fn set_schema_changed(&mut self, value: bool) -> &mut Self

pub fn schema_changed(&self) -> bool

pub fn inline_format(&self) -> InlineFormat

pub fn as_inner(&self) -> u32

Trait Implementations

impl Binary for Layout

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

Formats the value using the given formatter.

impl BitAnd for Layout

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

The bitwise and (&) of the bits in two flags values.

type Output = Layout

The resulting type after applying the & operator.

impl BitAndAssign for Layout

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Layout

fn bitor(self, other: Layout) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = Layout

The resulting type after applying the | operator.

impl BitOrAssign for Layout

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Layout

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Layout

The resulting type after applying the ^ operator.

impl BitXorAssign for Layout

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Layout

Returns the “default value” for a type.

impl Extend<Layout> for Layout

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

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for Layout

const FLAGS: &'static [Flag<Layout>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> Layout

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Layout> for Layout

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

The bitwise or (|) of the bits in each flags value.

impl Hash for Layout

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 IntoIterator for Layout

type Item = Layout

The type of the elements being iterated over.

type IntoIter = Iter<Layout>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Layout

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

Formats the value using the given formatter.

impl Not for Layout

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Layout

The resulting type after applying the ! operator.

impl Octal for Layout

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

Formats the value using the given formatter.

impl PartialEq for Layout

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PublicFlags for Layout

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for Layout

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Layout

The resulting type after applying the - operator.

impl SubAssign for Layout

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Layout

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

Formats the value using the given formatter.

impl Copy for Layout

impl Eq for Layout

impl StructuralPartialEq for Layout