Struct Requirement 

pub struct Requirement {
    pub ident: MeshIdent,
    pub locality: Locality,
    pub supply: Supply,
    pub provides: Option<Box<WorkloadSpec>>,
}

One thing a workload needs before it can run (W338).

Widens WorkloadSpec::depends_on rather than adding a second concept beside it: a requirement names an identity and answers the two questions the bare ident list cannot — which providers count (Locality) and what to do when none exists (Supply).

Each member of a group keeps its own mesh identity. A provider that may be satisfied remotely must be independently discoverable, so a requirement is an edge between two identities, never a way to collapse several workloads under one. Nothing about addressing, teardown-by-identity or the service-record rail changes.

Fields

ident: MeshIdent

Mesh identity of the provider. The same currency a WorkloadSpec::depends_on entry is written in.

locality: Locality

Which providers count as satisfying this. Defaults to Locality::Anywhere, the depends_on meaning.

supply: Supply

What to do when nothing satisfies it. Defaults to Supply::Wait, the depends_on meaning.

provides: Option<Box<WorkloadSpec>>

The provider’s own spec, carried here when supply = "self".

Required for Supply::SelfProvision and forbidden for Supply::Wait — a wait requirement names a provider someone else declares, so a spec here would have no owner. Both directions are enforced by validate::shape.

Boxed because this makes WorkloadSpec recursive. The recursion is bounded at depth 1: a provides spec may not itself carry a self-supplied requirement (also enforced in validate::shape), so composition stays a requirer plus its immediate providers rather than an arbitrarily deep tree.

Trait Implementations

impl Clone for Requirement

fn clone(&self) -> Requirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Requirement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Requirement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Requirement

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Requirement

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 Requirement

impl TS for Requirement

type WithoutGenerics = Requirement

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = Requirement

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.