ShardingApi

Struct ShardingApi 

Source
pub struct ShardingApi;
Expand description

ShardingApi

Public API façade for shard placement and inspection.

Responsibilities:

  • Expose read-only sharding queries
  • Expose sharding workflows (assignment / planning)
  • Normalize internal Error into PublicError

Does not:

  • Contain business logic
  • Interpret policies
  • Access storage directly

Implementations§

Source§

impl ShardingApi

Source

pub fn lookup_tenant(pool: &str, tenant: &str) -> Option<Principal>

Lookup the shard assigned to a tenant in a pool, if any.

Source

pub fn require_tenant_shard( pool: &str, tenant: impl AsRef<str>, ) -> Result<Principal, PublicError>

Return the shard for a tenant, or a PublicError if unassigned.

Source

pub fn registry_view() -> ShardingRegistryView

Return a view of the full sharding registry.

Source

pub fn tenants_view(pool: &str, shard: Principal) -> ShardingTenantsView

Return all tenants currently assigned to a shard.

Source

pub async fn assign_to_pool( pool: &str, tenant: impl AsRef<str>, ) -> Result<Principal, PublicError>

Assign a tenant to a shard in the given pool.

This performs validation, selection, and persistence.

Source

pub fn plan_assign_to_pool( pool: &str, tenant: impl AsRef<str>, ) -> Result<ShardingPlanStateView, PublicError>

Perform a dry-run shard assignment and return the resulting plan.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V