Skip to main content

CompositionPolicy

Struct CompositionPolicy 

Source
pub struct CompositionPolicy<R = SequentialReadPolicy, W = OptimisticParallelWritePolicy>{ /* private fields */ }
Expand description

Bundle of read, write, and refill policies for CompositionBackend.

This struct provides a builder pattern for configuring all three policy types together, making it easy to create and reuse policy configurations.

§Example

use hitbox_backend::composition::{CompositionPolicy, CompositionBackend};
use hitbox_backend::composition::policy::{RaceReadPolicy, SequentialWritePolicy, RefillPolicy};

let policy = CompositionPolicy::new()
    .read(RaceReadPolicy::new())
    .write(SequentialWritePolicy::new())
    .refill(RefillPolicy::Always);

let backend = CompositionBackend::new(l1, l2)
    .with_policy(policy);

Implementations§

Source§

impl CompositionPolicy<SequentialReadPolicy, OptimisticParallelWritePolicy>

Source

pub fn new() -> Self

Create a new policy bundle with default policies.

Default policies:

  • Read: SequentialReadPolicy (try L1 first, then L2)
  • Write: OptimisticParallelWritePolicy (write to both, succeed if ≥1 succeeds)
  • Refill: RefillPolicy::Never (do not populate L1 after L2 hit)
Source§

impl<R, W> CompositionPolicy<R, W>

Source

pub fn read<NewR: CompositionReadPolicy>( self, read: NewR, ) -> CompositionPolicy<NewR, W>

Set the read policy (builder pattern).

§Example
use hitbox_backend::composition::CompositionPolicy;
use hitbox_backend::composition::policy::RaceReadPolicy;

let policy = CompositionPolicy::new()
    .read(RaceReadPolicy::new());
Source

pub fn write<NewW: CompositionWritePolicy>( self, write: NewW, ) -> CompositionPolicy<R, NewW>

Set the write policy (builder pattern).

§Example
use hitbox_backend::composition::CompositionPolicy;
use hitbox_backend::composition::policy::SequentialWritePolicy;

let policy = CompositionPolicy::new()
    .write(SequentialWritePolicy::new());
Source

pub fn refill(self, refill: RefillPolicy) -> CompositionPolicy<R, W>

Set the refill policy (builder pattern).

§Example
use hitbox_backend::composition::CompositionPolicy;
use hitbox_backend::composition::policy::RefillPolicy;

let policy = CompositionPolicy::new()
    .refill(RefillPolicy::Always);
Source

pub fn read_policy(&self) -> &R

Get a reference to the read policy.

Source

pub fn write_policy(&self) -> &W

Get a reference to the write policy.

Source

pub fn refill_policy(&self) -> &RefillPolicy

Get a reference to the refill policy.

Trait Implementations§

Source§

impl<R, W> Clone for CompositionPolicy<R, W>

Source§

fn clone(&self) -> CompositionPolicy<R, W>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<R, W> Debug for CompositionPolicy<R, W>

Source§

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

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

impl Default for CompositionPolicy<SequentialReadPolicy, OptimisticParallelWritePolicy>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<R, W> Freeze for CompositionPolicy<R, W>
where R: Freeze, W: Freeze,

§

impl<R, W> RefUnwindSafe for CompositionPolicy<R, W>

§

impl<R, W> Send for CompositionPolicy<R, W>

§

impl<R, W> Sync for CompositionPolicy<R, W>

§

impl<R, W> Unpin for CompositionPolicy<R, W>
where R: Unpin, W: Unpin,

§

impl<R, W> UnwindSafe for CompositionPolicy<R, W>
where R: UnwindSafe, W: UnwindSafe,

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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