Struct Label 

pub struct Label { /* private fields */ }

A label used to identify annotations in a dataset.

When fetched with a version tag, the server returns a reduced snapshot shape (database.TagLabel) that omits dataset_id but includes color — Label::dataset_id is backfilled by the client from the query context in that case. The HEAD-scoped path returns dataset_id but has historically not modeled color, so Label::color returns None there unless the server starts including it.

Implementations

impl Label

pub fn id(&self) -> u64

pub fn dataset_id(&self) -> Option<DatasetID>

Returns the dataset ID this label belongs to. When this value was fetched via a tag-scoped query, the server does not return dataset_id on the wire; the client backfills it from the dataset_id argument the query was made with.

pub fn index(&self) -> u64

pub fn name(&self) -> &str

pub fn color(&self) -> Option<u64>

Returns the label’s display color as a packed RGB integer, if the server returned one. Populated on both HEAD and tag-scoped reads.

pub async fn remove(&self, client: &Client) -> Result<(), Error>

pub async fn set_name( &mut self, client: &Client, name: &str, ) -> Result<(), Error>

pub async fn set_index( &mut self, client: &Client, index: u64, ) -> Result<(), Error>

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Label

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Label

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

Formats the value using the given formatter.

impl Eq for Label

impl Hash for Label

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 Label

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Label