Skip to main content

ShardingApi

Struct ShardingApi 

Source
pub struct ShardingApi;
Expand description

ShardingApi

Implementations§

Source§

impl ShardingApi

Source

pub fn lookup_partition_key( pool: &str, partition_key: &str, ) -> Option<Principal>

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

Source

pub fn resolve_shard_for_key( pool: &str, partition_key: impl AsRef<str>, ) -> Result<Principal, Error>

Return the shard for a partition_key, or an Error if unassigned.

Source

pub fn registry() -> ShardingRegistryResponse

Return a view of the full sharding registry.

Source

pub fn partition_keys( pool: &str, shard: Principal, ) -> ShardingPartitionKeysResponse

Return all partition_keys currently assigned to a shard.

Source

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

Assign a partition_key to a shard in the given pool.

Source

pub fn plan_assign_to_pool( pool: &str, partition_key: impl AsRef<str>, ) -> Result<ShardingPlanStateResponse, Error>

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.