Enum stam::Item

pub enum Item<'a, T>where
    T: Storable,{
    Id(String),
    IdRef(&'a str),
    Ref(&'a T),
    Handle(T::HandleType),
    None,
}

Item offers various ways of referring to a data structure of type T in the core STAM model It abstracts over public IDs (both owned an and borrowed), handles, and references.

Variants

Id(String)

IdRef(&'a str)

Ref(&'a T)

Handle(T::HandleType)

None

Implementations

impl<'a, T> Item<'a, T>where T: Storable,

pub fn is_handle(&self) -> bool

pub fn is_id(&self) -> bool

pub fn is_none(&self) -> bool

pub fn is_some(&self) -> bool

pub fn error(&self, contextmsg: &'static str) -> StamError

pub fn to_string(self) -> Option<String>

Returns the ID as a new string, returns None if only handle is contained

pub fn as_str(&'a self) -> Option<&'a str>

Returns the ID as str, returns None if only handle is contained

impl<'a, T> Item<'a, T>where T: Storable,

pub fn to_handle<S>(&self, store: &S) -> Option<T::HandleType>where S: StoreFor<T>,

pub fn to_id<S>(&'a self, store: &'a S) -> Option<&'a str>where S: StoreFor<T>,

pub fn to_ref<'s, S>(&'a self, store: &'s S) -> Option<&'s T>where S: StoreFor<T>,

Trait Implementations

impl<'a, T> Clone for Item<'a, T>where T: Storable,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Item<'a, T>where T: Storable + Debug, T::HandleType: Debug,

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

Formats the value using the given formatter.

impl<'a, T> Default for Item<'a, T>where T: Storable,

fn default() -> Self

Returns the “default value” for a type.

impl<'de: 'a, 'a, T> Deserialize<'de> for Item<'a, T>where T: Storable,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, T> From<&'a String> for Item<'a, T>where T: Storable,

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

Converts to this type from the input type.

impl<'a, T> From<&'a T> for Item<'a, T>where T: Storable,

fn from(instance: &'a T) -> Self

Converts to this type from the input type.

impl<'a, T> From<&'a str> for Item<'a, T>where T: Storable,

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

Converts to this type from the input type.

impl<'a> From<&AnnotationDataHandle> for Item<'a, AnnotationData>

fn from(handle: &AnnotationDataHandle) -> Self

Converts to this type from the input type.

impl<'a> From<&AnnotationDataSetHandle> for Item<'a, AnnotationDataSet>

fn from(handle: &AnnotationDataSetHandle) -> Self

Converts to this type from the input type.

impl<'a> From<&AnnotationHandle> for Item<'a, Annotation>

fn from(handle: &AnnotationHandle) -> Self

Converts to this type from the input type.

impl<'a> From<&DataKeyHandle> for Item<'a, DataKey>

fn from(handle: &DataKeyHandle) -> Self

Converts to this type from the input type.

impl<'a> From<&TextResourceHandle> for Item<'a, TextResource>

fn from(handle: &TextResourceHandle) -> Self

Converts to this type from the input type.

impl<'a> From<AnnotationDataHandle> for Item<'a, AnnotationData>

fn from(handle: AnnotationDataHandle) -> Self

Converts to this type from the input type.

impl<'a> From<AnnotationDataSetHandle> for Item<'a, AnnotationDataSet>

fn from(handle: AnnotationDataSetHandle) -> Self

Converts to this type from the input type.

impl<'a> From<AnnotationHandle> for Item<'a, Annotation>

fn from(handle: AnnotationHandle) -> Self

Converts to this type from the input type.

impl<'a> From<DataKeyHandle> for Item<'a, DataKey>

fn from(handle: DataKeyHandle) -> Self

Converts to this type from the input type.

impl<'a, T> From<Option<&'a str>> for Item<'a, T>where T: Storable,

fn from(id: Option<&'a str>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&AnnotationDataHandle>> for Item<'a, AnnotationData>

fn from(handle: Option<&AnnotationDataHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&AnnotationDataSetHandle>> for Item<'a, AnnotationDataSet>

fn from(handle: Option<&AnnotationDataSetHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&AnnotationHandle>> for Item<'a, Annotation>

fn from(handle: Option<&AnnotationHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&DataKeyHandle>> for Item<'a, DataKey>

fn from(handle: Option<&DataKeyHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&TextResourceHandle>> for Item<'a, TextResource>

fn from(handle: Option<&TextResourceHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&TextSelectionHandle>> for Item<'a, TextSelection>

fn from(handle: Option<&TextSelectionHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<AnnotationDataHandle>> for Item<'a, AnnotationData>

fn from(handle: Option<AnnotationDataHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<AnnotationDataSetHandle>> for Item<'a, AnnotationDataSet>

fn from(handle: Option<AnnotationDataSetHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<AnnotationHandle>> for Item<'a, Annotation>

fn from(handle: Option<AnnotationHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<DataKeyHandle>> for Item<'a, DataKey>

fn from(handle: Option<DataKeyHandle>) -> Self

Converts to this type from the input type.

impl<'a, T> From<Option<String>> for Item<'a, T>where T: Storable,

fn from(id: Option<String>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<TextResourceHandle>> for Item<'a, TextResource>

fn from(handle: Option<TextResourceHandle>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<TextSelectionHandle>> for Item<'a, TextSelection>

fn from(handle: Option<TextSelectionHandle>) -> Self

Converts to this type from the input type.

impl<'a, T> From<Option<usize>> for Item<'a, T>where T: Storable,

fn from(handle: Option<usize>) -> Self

Converts to this type from the input type.

impl<'a, T> From<String> for Item<'a, T>where T: Storable,

fn from(id: String) -> Self

Converts to this type from the input type.

impl<'a> From<TextResourceHandle> for Item<'a, TextResource>

fn from(handle: TextResourceHandle) -> Self

Converts to this type from the input type.

impl<'a, T> From<usize> for Item<'a, T>where T: Storable,

fn from(handle: usize) -> Self

Converts to this type from the input type.

impl<'a, T> PartialEq<&str> for Item<'a, T>where T: Storable,

This allows us to pass a reference to any stored item and get back the best AnyId for it Will panic on totally unbounded that also don’t have a public ID

fn eq(&self, other: &&str) -> 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, T> PartialEq<Item<'a, T>> for Item<'a, T>where T: Storable,

fn eq(&self, other: &Self) -> 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, T> PartialEq<String> for Item<'a, T>where T: Storable,

fn eq(&self, other: &String) -> 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, T> PartialEq<str> for Item<'a, T>where T: Storable,

fn eq(&self, other: &str) -> 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.