Skip to main content

Contest

Struct Contest 

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

Fleet-shared contest handle. Cheap to clone.

Implementations§

Source§

impl Contest

Source

pub fn new(fleet: Arc<Fleet>) -> Self

Source

pub fn reset_ring(&self) -> Result<()>

Clear the shared contest ring.

Intended for owner-controlled boot-time cleanup before peer processes publish claims. It is not a runtime coordination tool.

Source

pub fn try_claim<T: ContestType>( &self, subject: impl Into<String>, owner: impl Into<ContestOwner>, ttl: Duration, ) -> Result<Claim>

Try to become the first active claimant for a typed subject.

The caller supplies an owner label only for observability. Orbit does not interpret it.

Source

pub fn try_claim_at<T: ContestType>( &self, subject: impl Into<String>, owner: impl Into<ContestOwner>, ttl: Duration, now_ms: u64, ) -> Result<Claim>

Same as Self::try_claim, but with an explicit clock value. Useful for deterministic tests and embedders with their own time source.

Source

pub fn try_claim_subject( &self, subject: ContestSubject, owner: impl Into<ContestOwner>, ttl: Duration, ) -> Result<Claim>

Try to claim a pre-built subject.

Source

pub fn try_claim_subject_at( &self, subject: ContestSubject, owner: impl Into<ContestOwner>, ttl: Duration, now_ms: u64, ) -> Result<Claim>

Same as Self::try_claim_subject, but with an explicit clock.

Source

pub fn guard_holder(&self, holder: Holder) -> Guard

Turn an observed holder into a drop-released guard.

This is useful for re-entrant owners: a process may observe that it already owns the active claim, continue carrying the same responsibility, and release the original claim when the guard leaves scope.

Source

pub fn release_holder(&self, holder: &Holder) -> Result<NetId64>

Release a holder observed through a yield path.

This is useful for re-entrant owners: a process may keep probing under its own still-active claim, then release that original claim when the guarded work succeeds.

Trait Implementations§

Source§

impl Clone for Contest

Source§

fn clone(&self) -> Contest

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 Contest

Source§

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

Formats the value using the given formatter. 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> 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