#[repr(transparent)]
pub struct Layout(_);
Expand description

Inline memory layout for raw block.

Implementations§

source§

impl Layout

source

pub const WITH_TABLE_NAME: Self = _

With table name in the block.

source

pub const WITH_FIELD_NAMES: Self = _

With field names.

source

pub const WITH_GROUP_ID: Self = _

If raw data block contains group id.

source

pub const WITH_FIELD_SCHEMA: Self = _

If raw data contains schema

source

pub const NCHAR_IS_DECODED: Self = _

If NChar decoded or not in data block.

source

pub const SCHEMA_CHANGED: Self = _

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

source

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)|
+-----+----+----+-----+------+---+---+------+-------+------------+
source

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)|
+-----+----+----+---+---+------+-------+------------+
source

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)|
+-----+----+----+-------+------------|
source

pub const PRECISION_MASK: Self = _

Precision mask.

source

pub const PRECISION_CLEAR_MASK: Self = _

source

pub const IS_MILLIS: Self = _

source

pub const IS_MICROS: Self = _

source

pub const IS_NANOS: Self = _

source

pub const FORMAT_MASK: Self = _

source

pub const IS_RAW_DATA: Self = _

is raw data

source

pub const IS_RAW_META: Self = _

is raw meta

source

pub const IS_STB_DATA: Self = _

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

source

pub const IS_HEADER: Self = _

Is database schema, used for database rebuild.

source§

impl Layout

source

pub const fn empty() -> Self

Returns an empty set of flags.

source

pub const fn all() -> Self

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

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

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

source

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

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

source

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

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

source

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

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

This method is equivalent to union.

source

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

Removes the specified flags in-place.

This method is equivalent to difference.

source

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

source

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

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

source

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

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

source

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

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

source

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

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

source

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

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

source

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

source§

impl Layout

source

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

Iterate over enabled flag values.

source

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

Iterate over enabled flag values with their stringified names.

source§

impl Layout

source

pub fn precision(&self) -> Precision

source

pub fn expect_table_name(&self) -> bool

source

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

source

pub fn expect_field_names(&self) -> bool

source

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

source

pub fn nchar_is_decoded(&self) -> bool

source

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

source

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

source

pub fn with_schema_changed(self) -> Self

source

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

source

pub fn schema_changed(&self) -> bool

source

pub fn inline_format(&self) -> InlineFormat

source

pub fn as_inner(&self) -> u32

Trait Implementations§

source§

impl Binary for Layout

source§

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

Formats the value using the given formatter.
source§

impl BitAnd<Layout> for Layout

source§

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

Returns the intersection between the two sets of flags.

§

type Output = Layout

The resulting type after applying the & operator.
source§

impl BitAndAssign<Layout> for Layout

source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

source§

impl BitOr<Layout> for Layout

source§

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

Returns the union of the two sets of flags.

§

type Output = Layout

The resulting type after applying the | operator.
source§

impl BitOrAssign<Layout> for Layout

source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

source§

impl BitXor<Layout> for Layout

source§

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

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

§

type Output = Layout

The resulting type after applying the ^ operator.
source§

impl BitXorAssign<Layout> for Layout

source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

source§

impl Clone for Layout

source§

fn clone(&self) -> Layout

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Layout

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Layout

source§

fn default() -> Layout

Returns the “default value” for a type. Read more
source§

impl Extend<Layout> for Layout

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl Flags for Layout

source§

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

The set of available flags and their names.
§

type Bits = u32

The underlying storage type.
source§

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.
source§

fn from_bits_retain(bits: u32) -> Layout

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

fn empty() -> Self

Returns an empty set of flags.
source§

fn all() -> Self

Returns the set containing all flags.
source§

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

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

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

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

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

Get the flag for a particular name.
source§

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

Iterate over enabled flag values.
source§

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

Iterate over the raw names and bits for enabled flag values.
source§

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.
source§

fn is_all(&self) -> bool

Returns true if all flags are currently set.
source§

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

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

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

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

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place. Read more
source§

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place. Read more
source§

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place. Read more
source§

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

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

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

Returns the intersection between the flags in self and other.
source§

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

Returns the union of between the flags in self and other.
source§

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

Returns the difference between the flags in self and other.
source§

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

Returns the symmetric difference between the flags in self and other.
source§

fn complement(self) -> Self

Returns the complement of this set of flags.
source§

impl FromIterator<Layout> for Layout

source§

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

Creates a value from an iterator. Read more
source§

impl Hash for Layout

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for Layout

source§

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

Formats the value using the given formatter.
source§

impl Not for Layout

source§

fn not(self) -> Self

Returns the complement of this set of flags.

§

type Output = Layout

The resulting type after applying the ! operator.
source§

impl Octal for Layout

source§

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

Formats the value using the given formatter.
source§

impl PartialEq<Layout> for Layout

source§

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

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

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.
source§

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.
source§

impl Sub<Layout> for Layout

source§

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

Returns the set difference of the two sets of flags.

§

type Output = Layout

The resulting type after applying the - operator.
source§

impl SubAssign<Layout> for Layout

source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

source§

impl UpperHex for Layout

source§

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

Formats the value using the given formatter.
source§

impl Copy for Layout

source§

impl Eq for Layout

source§

impl StructuralEq for Layout

source§

impl StructuralPartialEq for Layout

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<B> BitFlags for Bwhere B: Flags,

§

type Iter = Iter<B>

👎Deprecated: use the Flags trait instead
An iterator over enabled flags in an instance of the type.
§

type IterNames = IterNames<B>

👎Deprecated: use the Flags trait instead
An iterator over the raw names and bits for enabled flags in an instance of the type.
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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 Twhere U: TryFrom<T>,

§

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.