[go: up one dir, main page]

ProcStack

Struct ProcStack 

Source
pub struct ProcStack {
    pub pid: AtomicUsize,
    /* private fields */
}
Expand description

Stack abstraction for lightweight processes

§Example

use lightproc::proc_stack::ProcStack;
use lightproc::proc_state::EmptyProcState;

ProcStack::default()
    .with_before_start(|s: &mut EmptyProcState| { println!("Before start"); })
    .with_after_complete(|s: &mut EmptyProcState| { println!("After complete"); })
    .with_after_panic(|s: &mut EmptyProcState| { println!("After panic"); });

Fields§

§pid: AtomicUsize

Process ID for the Lightweight Process

Can be used to identify specific processes during any executor, reactor implementations.

Implementations§

Source§

impl ProcStack

Source

pub fn with_pid(self, pid: usize) -> ProcStack

Adds pid for the process which is going to take this stack

§Example
use lightproc::proc_stack::ProcStack;

ProcStack::default()
    .with_pid(1);
Source

pub fn with_state<S>(self, state: S) -> ProcStack
where S: State + 'static,

Adds state for the process which is going to be embedded into this stack.

§Example
use lightproc::proc_stack::ProcStack;

pub struct GlobalState {
   pub amount: usize
}

ProcStack::default()
    .with_pid(1)
    .with_state(GlobalState { amount: 1 });
Source

pub fn with_before_start<C, S>(self, callback: C) -> ProcStack
where S: State, C: Fn(&mut S) + Send + Sync + 'static,

Adds a callback that will be executed before polling inner future to the stack

use lightproc::proc_stack::{ProcStack};
use lightproc::proc_state::EmptyProcState;

ProcStack::default()
    .with_before_start(|s: &mut EmptyProcState| { println!("Before start"); });
Source

pub fn with_after_complete<C, S>(self, callback: C) -> ProcStack
where S: State, C: Fn(&mut S) + Send + Sync + 'static,

Adds a callback that will be executed after inner future resolves to an output to the stack

use lightproc::proc_stack::ProcStack;
use lightproc::proc_state::EmptyProcState;

ProcStack::default()
    .with_after_complete(|s: &mut EmptyProcState| { println!("After complete"); });
Source

pub fn with_after_panic<C, S>(self, callback: C) -> ProcStack
where S: State, C: Fn(&mut S) + Send + Sync + 'static,

Adds a callback that will be executed after inner future panics to the stack

use lightproc::proc_stack::ProcStack;
use lightproc::proc_state::EmptyProcState;

ProcStack::default()
    .with_after_panic(|s: &mut EmptyProcState| { println!("After panic"); });
Source

pub fn get_pid(&self) -> usize

Utility function to get_pid for the implementation of executors.

use lightproc::proc_stack::ProcStack;

let proc = ProcStack::default().with_pid(123);

assert_eq!(proc.get_pid(), 123);
Source

pub fn get_state<S>(&self) -> S
where S: State + Copy + 'static,

Get the state which is embedded into this ProcStack.

use lightproc::proc_stack::ProcStack;

#[derive(Copy, Clone)]
pub struct GlobalState {
   pub amount: usize
}

let mut proc = ProcStack::default().with_pid(123)
            .with_state(GlobalState { amount: 0} );

let state = proc.get_state::<GlobalState>();

Trait Implementations§

Source§

impl Clone for ProcStack

Source§

fn clone(&self) -> ProcStack

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 ProcStack

Source§

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

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

impl Default for ProcStack

Default implementation for the ProcStack

Source§

fn default() -> ProcStack

Returns the “default value” for a type. 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> AsAny for T
where T: Any,

Source§

fn as_any(&mut self) -> &mut (dyn Any + 'static)

Downcast implemented type to Any.
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> IntoEither for T

Source§

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

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Message for T
where T: Any + Send + Sync + Debug,

Source§

impl<T> State for T
where T: Send + Sync + 'static,