Struct tarantool::index::Metadata

pub struct Metadata<'a> {
    pub space_id: SpaceId,
    pub index_id: IndexId,
    pub name: Cow<'a, str>,
    pub type: IndexType,
    pub opts: BTreeMap<Cow<'a, str>, Value<'a>>,
    pub parts: Vec<Part>,
}

Representation of a tuple holding index metadata in system _index space.

Fields

space_id: SpaceId

index_id: IndexId

name: Cow<'a, str>

type: IndexType

opts: BTreeMap<Cow<'a, str>, Value<'a>>

parts: Vec<Part>

Implementations

impl Metadata<'_>

pub fn to_key_def(&self) -> KeyDef

Construct a KeyDef instance from index parts.

Panicking

Will panic if any of the parts have field name instead of field number. Normally this doesn’t happen, because Metadata returned from _index always has field number, but if you got this metadata from somewhere else, use Self::try_to_key_def instead, to check for this error.

pub fn try_to_key_def(&self) -> Result<KeyDef, FieldMustBeNumber>

Construct a KeyDef instance from index parts. Returns error in case any of the parts had field name instead of field number.

pub fn to_key_def_for_key(&self) -> KeyDef

Construct a KeyDef instance from index parts for comparing keys only.

The difference between this function and Self::to_key_def is that the latter is used to compare tuples of a space, while the former is used to compare only the keys.

Trait Implementations

impl<'a> Clone for Metadata<'a>

fn clone(&self) -> Metadata<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Metadata<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Metadata<'a>

fn default() -> Metadata<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for Metadata<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for Metadata<'_>

fn encode(&self, w: &mut impl Write) -> Result<()>

impl<'a> PartialEq for Metadata<'a>

fn eq(&self, other: &Metadata<'a>) -> 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<'a> Serialize for Metadata<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Metadata<'_>> for KeyDef

type Error = FieldMustBeNumber

The type returned in the event of a conversion error.

fn try_from(meta: &Metadata<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for Metadata<'a>

impl<'a> StructuralEq for Metadata<'a>

impl<'a> StructuralPartialEq for Metadata<'a>