Skip to main content

SubnetPolicy

Struct SubnetPolicy 

Source
pub struct SubnetPolicy { /* private fields */ }
Expand description

Policy for assigning nodes to subnets based on capability tags.

Rules are evaluated in order. Each rule maps a tag prefix to a hierarchy level and provides a value map for the tag’s value.

Example: a node with tags ["region:us-west", "fleet:alpha"] and rules:

  • SubnetRule { tag_prefix: "region:", level: 0, values: {"us-west": 1} }
  • SubnetRule { tag_prefix: "fleet:", level: 1, values: {"alpha": 2} }

Would get SubnetId::new(&[1, 2]).

§Semantics (rule precedence and matching contract)

Pinned by unit tests in this module — changes here are behavioral breaks for operators configuring subnets:

  1. Rule order is declaration order. assign() walks rules in the order passed to add_rule(). Two rules targeting the same level with overlapping values resolve as later-rule-wins: the earlier rule may write the level byte first, but a subsequent match at the same level overwrites it.
  2. First tag wins per rule. Inside one rule, the first capability tag whose stripped suffix is present in values wins — subsequent tags matching the same rule are ignored.
  3. No partial-prefix match on values. tag_prefix is stripped by str::strip_prefix; the remaining value is then looked up by exact string equality against values. A rule region: matching on "us" will not match the tag region:us:extra (the stripped suffix "us:extra" is not in the values map).
  4. Unmatched levels stay zero. Levels with no rule (or a rule that failed to match) remain 0, which SubnetId interprets as “no restriction at this level”.

Implementations§

Source§

impl SubnetPolicy

Source

pub fn new() -> Self

Create an empty policy (all nodes get SubnetId::GLOBAL).

Source

pub fn add_rule(self, rule: SubnetRule) -> Self

Add a rule to the policy.

§Panics

Panics if the rule’s level is >= 4. For untrusted input (config files, FFI, JSON) prefer Self::try_add_rule, which returns a SubnetError instead of panicking.

Source

pub fn try_add_rule(self, rule: SubnetRule) -> Result<Self, SubnetError>

Fallible variant of Self::add_rule.

Pre-existing add_rule panics on rule.level >= 4. Subnet policies typically come from config / FFI / JSON and a malformed entry should surface as a recoverable error rather than crashing the daemon loader.

Source

pub fn assign(&self, caps: &CapabilitySet) -> SubnetId

Assign a subnet ID to a node based on its capability tags.

Evaluates all rules against the node’s tags. Unmatched levels remain zero (meaning “no restriction at that level”).

Trait Implementations§

Source§

impl Clone for SubnetPolicy

Source§

fn clone(&self) -> SubnetPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SubnetPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SubnetPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more