Enum bonsaidb_core::schema::NamedReference

pub enum NamedReference<'a, Id> {
    Name(Cow<'a, str>),
    Id(DocumentId),
    Key(Id),
}

A reference to a collection that has a unique name view.

Variants

Name(Cow<'a, str>)

An entity’s name.

Id(DocumentId)

A document id.

Key(Id)

A document id.

Implementations

impl<'a, Id> NamedReference<'a, Id>

where Id: for<'k> Key<'k>,

pub fn into_owned(self) -> NamedReference<'static, Id>

Converts this reference to an owned reference with a 'static lifetime.

pub fn id<Col: NamedCollection<PrimaryKey = Id>, Cn: Connection>( &self, connection: &Cn ) -> Result<Option<Col::PrimaryKey>, Error>

Returns this reference’s id. If the reference is a name, the NamedCollection::ByNameView is queried for the id.

pub async fn id_async<Col: NamedCollection<PrimaryKey = Id>, Cn: AsyncConnection>( &self, connection: &Cn ) -> Result<Option<Col::PrimaryKey>, Error>

Returns this reference’s id. If the reference is a name, the NamedCollection::ByNameView is queried for the id.

Trait Implementations

impl<'a, Id: Clone> Clone for NamedReference<'a, Id>

fn clone(&self) -> NamedReference<'a, Id>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Id: Debug> Debug for NamedReference<'a, Id>

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

Formats the value using the given formatter.

impl<'de, 'a, Id> Deserialize<'de> for NamedReference<'a, Id>

where Id: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'b, Id> From<&'b BorrowedDocument<'b>> for NamedReference<'a, Id>

fn from(doc: &'b BorrowedDocument<'b>) -> Self

Converts to this type from the input type.

impl<'a, Id> From<&'a String> for NamedReference<'a, Id>

fn from(name: &'a String) -> Self

Converts to this type from the input type.

impl<'a, Id> From<&'a str> for NamedReference<'a, Id>

fn from(name: &'a str) -> Self

Converts to this type from the input type.

impl<'a, Id> From<DocumentId> for NamedReference<'a, Id>

fn from(id: DocumentId) -> Self

Converts to this type from the input type.

impl<'a, Id> From<String> for NamedReference<'a, Id>

fn from(name: String) -> Self

Converts to this type from the input type.

impl<'a, Id> Nameable<'a, Id> for &'a NamedReference<'a, Id>

where Id: Clone,

fn name(self) -> Result<NamedReference<'a, Id>, Error>

Returns this name as a NamedReference.

impl<'a, Id> Nameable<'a, Id> for NamedReference<'a, Id>

fn name(self) -> Result<NamedReference<'a, Id>, Error>

Returns this name as a NamedReference.

impl<'a, Id: PartialEq> PartialEq for NamedReference<'a, Id>

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

where Id: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, 'c, C> TryFrom<&'c CollectionDocument<C>> for NamedReference<'a, C::PrimaryKey>

where C: SerializedCollection,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(doc: &'c CollectionDocument<C>) -> Result<Self, Error>

Performs the conversion.

impl<'a, Id: Eq> Eq for NamedReference<'a, Id>

impl<'a, Id> StructuralEq for NamedReference<'a, Id>

impl<'a, Id> StructuralPartialEq for NamedReference<'a, Id>