Skip to main content

ActorConfig

Struct ActorConfig 

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

Per-actor configuration.

Controls settings that vary between actors, such as the mailbox channel capacity. Created automatically by Supervisor::add_actor using global defaults from SupervisorConfig, or customized via ActorBuilder.

§Examples

use maiko::{SupervisorConfig, ActorConfig};

let config = ActorConfig::new(&SupervisorConfig::default())
    .with_channel_capacity(512)
    .with_max_events_per_tick(64);

assert_eq!(config.channel_capacity(), 512);
assert_eq!(config.max_events_per_tick(), 64);

With the builder API (see ActorBuilder):

sup.build_actor("writer", |ctx| Writer::new(ctx))
    .channel_capacity(512)
    .topics(&[Topic::Data])
    .build()?;

Implementations§

Source§

impl ActorConfig

Source

pub fn new(global_config: &SupervisorConfig) -> Self

Create a new config inheriting defaults from the global SupervisorConfig.

Source

pub fn with_channel_capacity(self, channel_capacity: usize) -> Self

Set the actor’s mailbox channel capacity.

This is the number of events that can be queued for this actor before the broker’s overflow policy takes effect.

Source

pub fn channel_capacity(&self) -> usize

Returns the actor’s mailbox channel capacity.

Source

pub fn with_max_events_per_tick(self, max_events: usize) -> Self

Set the maximum number of events processed per tick cycle.

After processing this many events, the actor yields to allow other tasks to run and to call Actor::step.

Source

pub fn max_events_per_tick(&self) -> usize

Returns the maximum number of events processed per tick cycle.

Trait Implementations§

Source§

impl Clone for ActorConfig

Source§

fn clone(&self) -> ActorConfig

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 Debug for ActorConfig

Source§

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

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

impl Default for ActorConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for ActorConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for ActorConfig

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ActorConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ActorConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for ActorConfig

Source§

impl Eq for ActorConfig

Source§

impl StructuralPartialEq for ActorConfig

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,