Struct Designator 

pub struct Designator(/* private fields */);

Names a tracker without conveying anything about it: <plugin>/<64 lowercase hex>, the SHA-256 of <plugin>\n<identifier> over the backend’s own opaque identifier of itself — a Linear workspace’s organization id, a GitHub Project’s node id — or, for a plugin whose backend has none, alias/<public_alias>, the alias every host’s configuration of that tracker declares identically.

The one spelling, validated wherever one is built or read, so a stored opaque edge cannot carry anything a designator does not.

Implementations

impl Designator

pub const ALIAS_PREFIX: &'static str = "alias"

The prefix of a designator built from a configured public_alias.

pub fn of_backend(plugin: &str, identifier: &str) -> Result<Self, String>

The designator of a backend plugin identifies by identifier, its own opaque identifier of itself.

Errors

A message when plugin is not a plugin kind’s spelling — the pattern a source name matches — or is Self::ALIAS_PREFIX, which an alias designator’s prefix is.

pub fn of_alias(alias: &str) -> Result<Self, String>

The designator of a tracker whose configuration declares alias as its public_alias.

Errors

A message naming the pattern when alias is not one.

pub fn is_public_alias(alias: &str) -> bool

Whether alias is a valid public_alias: ^[A-Za-z0-9_-]{16,64}$.

pub fn as_str(&self) -> &str

The designator as it is spelled.

pub fn prefix(&self) -> &str

What comes before the /: the plugin whose backend it digests, or Self::ALIAS_PREFIX.

pub fn is_alias(&self) -> bool

Whether it was built from a configured public_alias.

Trait Implementations

impl Clone for Designator

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Designator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Designator

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Designator

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

Formats the value using the given formatter.

impl Eq for Designator

impl Hash for Designator

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 JsonSchema for Designator

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for Designator

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Designator

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Designator

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Designator

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 Designator

impl TryFrom<String> for Designator

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.