Struct LogicalFieldId 

pub struct LogicalFieldId { /* private fields */ }

A namespaced logical identifier for a column.

This 64-bit struct is designed to prevent ID collisions by partitioning the key space into distinct namespaces, table IDs, and field IDs.

Implementations

impl LogicalFieldId

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl LogicalFieldId

pub const fn into_bytes(self) -> [u8; 8]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 8]) -> Self

Converts the given bytes directly into the bitfield struct.

impl LogicalFieldId

pub fn field_id(&self) -> <B32 as Specifier>::InOut

Returns the value of field_id. The specific field/column within a table (up to ~4.3 billion).

pub fn field_id_or_err( &self, ) -> Result<<B32 as Specifier>::InOut, InvalidBitPattern<<B32 as Specifier>::Bytes>>

Returns the value of field_id.

Errors

If the returned value contains an invalid bit pattern for field_id. The specific field/column within a table (up to ~4.3 billion).

pub fn with_field_id(self, new_val: <B32 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of field_id set to the given value.

Panics

If the given value is out of bounds for field_id. The specific field/column within a table (up to ~4.3 billion).

pub fn with_field_id_checked( self, new_val: <B32 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of field_id set to the given value.

Errors

If the given value is out of bounds for field_id. The specific field/column within a table (up to ~4.3 billion).

pub fn set_field_id(&mut self, new_val: <B32 as Specifier>::InOut)

Sets the value of field_id to the given value.

Panics

If the given value is out of bounds for field_id. The specific field/column within a table (up to ~4.3 billion).

pub fn set_field_id_checked( &mut self, new_val: <B32 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of field_id to the given value.

Errors

If the given value is out of bounds for field_id. The specific field/column within a table (up to ~4.3 billion).

pub fn table_id(&self) -> <B16 as Specifier>::InOut

Returns the value of table_id. The table this field belongs to (up to 65,535).

pub fn table_id_or_err( &self, ) -> Result<<B16 as Specifier>::InOut, InvalidBitPattern<<B16 as Specifier>::Bytes>>

Returns the value of table_id.

Errors

If the returned value contains an invalid bit pattern for table_id. The table this field belongs to (up to 65,535).

pub fn with_table_id(self, new_val: <B16 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of table_id set to the given value.

Panics

If the given value is out of bounds for table_id. The table this field belongs to (up to 65,535).

pub fn with_table_id_checked( self, new_val: <B16 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of table_id set to the given value.

Errors

If the given value is out of bounds for table_id. The table this field belongs to (up to 65,535).

pub fn set_table_id(&mut self, new_val: <B16 as Specifier>::InOut)

Sets the value of table_id to the given value.

Panics

If the given value is out of bounds for table_id. The table this field belongs to (up to 65,535).

pub fn set_table_id_checked( &mut self, new_val: <B16 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of table_id to the given value.

Errors

If the given value is out of bounds for table_id. The table this field belongs to (up to 65,535).

pub fn namespace(&self) -> <Namespace as Specifier>::InOut

Returns the value of namespace. The type of data this ID represents (up to 65,536 namespaces).

pub fn namespace_or_err( &self, ) -> Result<<Namespace as Specifier>::InOut, InvalidBitPattern<<Namespace as Specifier>::Bytes>>

Returns the value of namespace.

Errors

If the returned value contains an invalid bit pattern for namespace. The type of data this ID represents (up to 65,536 namespaces).

pub fn with_namespace(self, new_val: <Namespace as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of namespace set to the given value.

Panics

If the given value is out of bounds for namespace. The type of data this ID represents (up to 65,536 namespaces).

pub fn with_namespace_checked( self, new_val: <Namespace as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of namespace set to the given value.

Errors

If the given value is out of bounds for namespace. The type of data this ID represents (up to 65,536 namespaces).

pub fn set_namespace(&mut self, new_val: <Namespace as Specifier>::InOut)

Sets the value of namespace to the given value.

Panics

If the given value is out of bounds for namespace. The type of data this ID represents (up to 65,536 namespaces).

pub fn set_namespace_checked( &mut self, new_val: <Namespace as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of namespace to the given value.

Errors

If the given value is out of bounds for namespace. The type of data this ID represents (up to 65,536 namespaces).

impl LogicalFieldId

pub fn from_parts( namespace: Namespace, table_id: TableId, field_id: FieldId, ) -> Self

Build a logical field identifier from its namespace, table, and field components.

pub fn for_user(table_id: TableId, field_id: FieldId) -> Self

Convenience constructor for user data columns.

pub fn for_user_table_0(field_id: FieldId) -> Self

Convenience constructor for user data columns in table 0.

Many tests use table 0 by default; this method avoids repeating the table ID literal.

Trait Implementations

impl CheckTotalSizeMultipleOf8 for LogicalFieldId

type Size = TotalSize<[(); 0]>

impl Clone for LogicalFieldId

fn clone(&self) -> LogicalFieldId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogicalFieldId

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

Formats the value using the given formatter.

impl Default for LogicalFieldId

fn default() -> LogicalFieldId

Returns the “default value” for a type.

impl From<LogicalFieldId> for Projection

fn from(logical_field_id: LogicalFieldId) -> Self

Converts to this type from the input type.

impl From<LogicalFieldId> for u64

where [(); 64]: IsU64Compatible,

fn from(__bf_bitfield: LogicalFieldId) -> Self

Converts to this type from the input type.

impl From<u64> for LogicalFieldId

where [(); 64]: IsU64Compatible,

fn from(__bf_prim: u64) -> Self

Converts to this type from the input type.

impl Hash for LogicalFieldId

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 PartialEq for LogicalFieldId

fn eq(&self, other: &LogicalFieldId) -> 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 Copy for LogicalFieldId

impl Eq for LogicalFieldId

impl StructuralPartialEq for LogicalFieldId