Skip to main content

PrincipalBudget

rama::proxy::masque::budget

Struct PrincipalBudget

pub struct PrincipalBudget { /* private fields */ }

Available on crate feature masque only.

Expand description

What all the tunnels of one principal may move together (TunnelLimits::with_principal_budget).

Every datagram a tunnel is charged is charged to its principal first, at the same cost; a datagram the principal’s budget refuses is dropped. The principal’s rates and quota outlive its tunnels: a principal is only forgotten once its rates would be full again and its quota window has ended, so closing and reopening tunnels never restores budget early.

Implementations§

impl PrincipalBudget

pub const fn new() -> PrincipalBudget

No rates or quota.

pub fn maybe_with_to_target(self, rate: Option<DatagramRate>) -> PrincipalBudget

The rate of datagrams from the principal’s clients to their targets.

pub fn maybe_set_to_target( &mut self, rate: Option<DatagramRate>, ) -> &mut PrincipalBudget

The rate of datagrams from the principal’s clients to their targets.

pub fn with_to_target(self, rate: DatagramRate) -> PrincipalBudget

The rate of datagrams from the principal’s clients to their targets.

pub fn set_to_target(&mut self, rate: DatagramRate) -> &mut PrincipalBudget

The rate of datagrams from the principal’s clients to their targets.

pub fn without_to_target(self) -> PrincipalBudget

The rate of datagrams from the principal’s clients to their targets.

pub fn unset_to_target(&mut self) -> &mut PrincipalBudget

The rate of datagrams from the principal’s clients to their targets.

pub fn maybe_with_to_client(self, rate: Option<DatagramRate>) -> PrincipalBudget

The rate of datagrams from the targets to the principal’s clients.

pub fn maybe_set_to_client( &mut self, rate: Option<DatagramRate>, ) -> &mut PrincipalBudget

The rate of datagrams from the targets to the principal’s clients.

pub fn with_to_client(self, rate: DatagramRate) -> PrincipalBudget

The rate of datagrams from the targets to the principal’s clients.

pub fn set_to_client(&mut self, rate: DatagramRate) -> &mut PrincipalBudget

The rate of datagrams from the targets to the principal’s clients.

pub fn without_to_client(self) -> PrincipalBudget

The rate of datagrams from the targets to the principal’s clients.

pub fn unset_to_client(&mut self) -> &mut PrincipalBudget

The rate of datagrams from the targets to the principal’s clients.

pub fn with_quota(self, bytes: u64, window: Duration) -> PrincipalBudget

The most bytes, both ways together, the principal is charged per window, which starts at its first charge. Only what the rates admitted counts.

pub fn set_quota( &mut self, bytes: u64, window: Duration, ) -> &mut PrincipalBudget

The most bytes, both ways together, the principal is charged per window, which starts at its first charge. Only what the rates admitted counts.

pub fn maybe_with_lifetime_quota(self, bytes: Option<u64>) -> PrincipalBudget

Total bytes across the principal’s lifetime. The accounting record remains retained after tunnels close, so reopening cannot reset it. Once the principal map fills, new principals are refused for the service lifetime. Prefer Self::with_quota for rotating identities.

pub fn maybe_set_lifetime_quota( &mut self, bytes: Option<u64>, ) -> &mut PrincipalBudget

Total bytes across the principal’s lifetime. The accounting record remains retained after tunnels close, so reopening cannot reset it. Once the principal map fills, new principals are refused for the service lifetime. Prefer Self::with_quota for rotating identities.

pub fn with_lifetime_quota(self, bytes: u64) -> PrincipalBudget

Total bytes across the principal’s lifetime. The accounting record remains retained after tunnels close, so reopening cannot reset it. Once the principal map fills, new principals are refused for the service lifetime. Prefer Self::with_quota for rotating identities.

pub fn set_lifetime_quota(&mut self, bytes: u64) -> &mut PrincipalBudget

Total bytes across the principal’s lifetime. The accounting record remains retained after tunnels close, so reopening cannot reset it. Once the principal map fills, new principals are refused for the service lifetime. Prefer Self::with_quota for rotating identities.

pub fn without_lifetime_quota(self) -> PrincipalBudget

Total bytes across the principal’s lifetime. The accounting record remains retained after tunnels close, so reopening cannot reset it. Once the principal map fills, new principals are refused for the service lifetime. Prefer Self::with_quota for rotating identities.

pub fn unset_lifetime_quota(&mut self) -> &mut PrincipalBudget

Total bytes across the principal’s lifetime. The accounting record remains retained after tunnels close, so reopening cannot reset it. Once the principal map fills, new principals are refused for the service lifetime. Prefer Self::with_quota for rotating identities.

Trait Implementations§

impl Clone for PrincipalBudget

fn clone(&self) -> PrincipalBudget

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

impl Copy for PrincipalBudget

impl Debug for PrincipalBudget

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

Formats the value using the given formatter. Read more

impl Default for PrincipalBudget

fn default() -> PrincipalBudget

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

impl Eq for PrincipalBudget

impl PartialEq for PrincipalBudget

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for PrincipalBudget

Auto Trait Implementations§

impl Freeze for PrincipalBudget

impl RefUnwindSafe for PrincipalBudget

impl Send for PrincipalBudget

impl Sync for PrincipalBudget

impl Unpin for PrincipalBudget

impl UnsafeUnpin for PrincipalBudget

impl UnwindSafe for PrincipalBudget

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

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

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

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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