[][src]Struct splinter::admin::rest_api::CircuitResourceProvider

pub struct CircuitResourceProvider<T: CircuitStore> { /* fields omitted */ }

Provides the REST API Resource definitions for listing and fetching the circuits in the splinter node's state.

The following endpoints are provided:

  • GET /admin/circuits - List circuits in Splinter's state
  • GET /admin/circuits/{circuit_id} - Fetch a specific circuit in Splinter's state by circuit ID

These endpoints are only available if the following REST API backend feature is enabled:

  • rest-api-actix

Methods

impl<T: CircuitStore + 'static> CircuitResourceProvider<T>[src]

pub fn new(node_id: String, store: T) -> Self[src]

Trait Implementations

impl<T: Clone + CircuitStore> Clone for CircuitResourceProvider<T>[src]

impl<T: CircuitStore + 'static> RestResourceProvider for CircuitResourceProvider<T>[src]

The circuit store provides the following endpoints as REST API resources:

  • GET /admin/circuits - List circuits in Splinter's state
  • GET /admin/circuits/{circuit_id} - Fetch a specific circuit in Splinter's state by circuit ID

These endpoints are only available if the following REST API backend feature is enabled:

  • rest-api-actix

Auto Trait Implementations

impl<T> RefUnwindSafe for CircuitResourceProvider<T> where
    T: RefUnwindSafe

impl<T> Send for CircuitResourceProvider<T>

impl<T> Sync for CircuitResourceProvider<T>

impl<T> Unpin for CircuitResourceProvider<T> where
    T: Unpin

impl<T> UnwindSafe for CircuitResourceProvider<T> where
    T: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<'a, T> DefaultFeatures<'a> for T where
    T: 'a + Clone + Send + Sync

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> IntoSql for T

impl<'a, T> NonSyncFeatures<'a> for T where
    T: 'a + Clone

impl<T> SafeBorrow<T> for T where
    T: ?Sized

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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