Enum Classification 

pub enum Classification {
    Public,
    Private,
}

Who may read an item: anybody, or only those who may read where it is kept.

Two values, ordered so the stricter is the greater: strictest of any two is the one an item they both describe carries. Nothing combines them any other way, which is what makes an explicit public unable to loosen a private repository or a private project — a classification only ever tightens.

It is recorded on the item and travels with it. A source whose backend has no notion of its own records it under Self::METADATA_KEY, exactly as it records Repository::METADATA_KEY, and only while it is private: an item without it is public, so every item written before this existed reads as it did.

Variants

Public

Anybody who may read the destination may read it.

Private

It may be written only to a destination verified private, and nothing of it may reach a public one.

Implementations

impl Classification

pub const METADATA_KEY: &'static str = "onetaskgraph.classification"

The reserved metadata key a source records a private classification under when its backend has no notion of its own.

Spelled once, here, for the reason Repository::METADATA_KEY is.

pub fn is_public(&self) -> bool

Whether this is Public — the value left out of the wire.

pub fn strictest(self, other: Self) -> Self

The stricter of the two.

pub const fn as_str(self) -> &'static str

The value as the wire spells it: public or private.

pub fn from_metadata(metadata: &BTreeMap<String, Value>) -> Result<Self, String>

The classification a source records under Self::METADATA_KEY, or public when it records none.

Errors

Returns a message when the key holds anything but one of the two spellings.

pub fn record(self, metadata: &mut BTreeMap<String, Value>)

Record this classification in metadata under Self::METADATA_KEY: present while private, absent while public.

Trait Implementations

impl Clone for Classification

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Classification

impl Debug for Classification

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

Formats the value using the given formatter.

impl Default for Classification

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Classification

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Classification

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

Formats the value using the given formatter.

impl Eq for Classification

impl FromStr for Classification

type Err = String

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Classification

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 Classification

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

The name of the generated JSON Schema.

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

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

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.

impl Ord for Classification

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 Classification

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Classification

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 Classification

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 Classification