Struct TaskRef 

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

One task named by another task’s Task::delivers or Task::delivered_by.

A string with one of two spellings, decided the way a DependencyEndpoint decides it: one holding a colon is <source>:<native> and names a task of any source, and one without is a bare native id naming a task of the source that holds the list. So a native id holding a colon cannot be named bare, exactly as it cannot in onetaskgraph.depends_on.

Implementations

impl TaskRef

pub const DELIVERS_KEY: &'static str = "onetaskgraph.delivers"

The reserved metadata key a source records Task::delivers under when its backend has no notion of its own.

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

pub const DELIVERED_BY_KEY: &'static str = "onetaskgraph.delivered_by"

The reserved metadata key a source records Task::delivered_by under when its backend has no notion of its own.

pub fn new(id: impl Into<String>) -> Result<Self, String>

One entry, once it is established it is a task id.

Errors

Returns a message saying why when the id is empty, or when it is qualified with a source name that breaks the pattern or with no native id after the colon.

pub fn qualified(source: &SourceName, native: &NativeId) -> Self

The qualified entry naming native in source.

pub fn as_str(&self) -> &str

The entry as it is spelled.

pub fn is_qualified(&self) -> bool

Whether the entry names its source in writing.

pub fn parts<'a>(&'a self, near_source: &'a str) -> (&'a str, &'a str)

The source and the native id this entry names, reading a bare entry as naming a task of near_source.

pub fn in_source(&self, near_source: &SourceName) -> Self

This entry qualified, reading a bare one as naming a task of near_source.

pub fn listed( field: &str, near: &NativeId, near_source: Option<&SourceName>, entries: Vec<Self>, ) -> Result<Vec<Self>, String>

The entries of one task’s list, once it is established that none names the task itself and none repeats.

field is what the list is called where it is stored, for the message. near is the task holding the list and near_source the configured name of the source holding it, which is what tells T-1 and work:T-1 apart as the same task. A source that does not know its own name passes None, and then only a bare entry can be recognised as naming this task or one of the other entries.

Errors

Returns a message naming the task and the entry.

pub fn from_value( field: &str, near: &NativeId, near_source: Option<&SourceName>, value: Option<&Value>, ) -> Result<Vec<Self>, String>

The entries one task’s list holds, read out of the JSON a source stores it as.

value is None when the source holds no list at all, which is the empty one.

Errors

Returns a message naming the task and the entry when the value is not a list, when an entry is not a task id, or when Self::listed refuses the list.

Trait Implementations

impl Clone for TaskRef

fn clone(&self) -> TaskRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TaskRef

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

Formats the value using the given formatter.

impl Eq for TaskRef

impl From<TaskRef> for String

fn from(entry: TaskRef) -> Self

Converts to this type from the input type.

impl Hash for TaskRef

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 TaskRef

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 TaskRef

fn cmp(&self, other: &TaskRef) -> 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 TaskRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TaskRef

fn partial_cmp(&self, other: &TaskRef) -> 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 TaskRef

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 TaskRef

impl TryFrom<String> for TaskRef

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.