[−][src]Enum casper_node::effect::requests::ApiRequest

#[must_use]pub enum ApiRequest<I> {
    SubmitDeploy {
        deploy: Box<Deploy>,
        responder: Responder<()>,
    },
    GetBlock {
        maybe_id: Option<BlockIdentifier>,
        responder: Responder<Option<LinearBlock>>,
    },
    QueryGlobalState {
        state_root_hash: Digest,
        base_key: Key,
        path: Vec<String>,
        responder: Responder<Result<QueryResult, Error>>,
    },
    QueryEraValidators {
        state_root_hash: Digest,
        protocol_version: ProtocolVersion,
        responder: Responder<Result<EraValidators, GetEraValidatorsError>>,
    },
    QueryProtocolData {
        protocol_version: ProtocolVersion,
        responder: Responder<Result<Option<Box<ProtocolData>>, Error>>,
    },
    GetBalance {
        state_root_hash: Digest,
        purse_uref: URef,
        responder: Responder<Result<BalanceResult, Error>>,
    },
    GetDeploy {
        hash: DeployHash,
        responder: Responder<Option<(Deploy, DeployMetadata<LinearBlock>)>>,
    },
    GetPeers {
        responder: Responder<HashMap<I, SocketAddr>>,
    },
    GetStatus {
        responder: Responder<StatusFeed<I>>,
    },
    GetMetrics {
        responder: Responder<Option<String>>,
    },
}

Abstract API request.

An API request is an abstract request that does not concern itself with serialization or transport.

Variants

SubmitDeploy

Submit a deploy to be announced.

Fields of SubmitDeploy

deploy: Box<Deploy>

The deploy to be announced.

responder: Responder<()>

Responder to call.

GetBlock

If maybe_hash is Some, return the specified block if it exists, else None. If maybe_hash is None, return the latest block.

Fields of GetBlock

maybe_id: Option<BlockIdentifier>

The hash of the block to be retrieved.

responder: Responder<Option<LinearBlock>>

Responder to call with the result.

QueryGlobalState

Query the global state at the given root hash.

Fields of QueryGlobalState

state_root_hash: Digest

The state root hash.

base_key: Key

Hex-encoded casper_types::Key.

path: Vec<String>

The path components starting from the key as base.

responder: Responder<Result<QueryResult, Error>>

Responder to call with the result.

QueryEraValidators

Query the global state at the given root hash.

Fields of QueryEraValidators

state_root_hash: Digest

The global state hash.

protocol_version: ProtocolVersion

The protocol version.

responder: Responder<Result<EraValidators, GetEraValidatorsError>>

Responder to call with the result.

QueryProtocolData

Query the contract runtime for protocol version data.

Fields of QueryProtocolData

protocol_version: ProtocolVersion

The protocol version.

responder: Responder<Result<Option<Box<ProtocolData>>, Error>>

Responder to call with the result.

GetBalance

Query the global state at the given root hash.

Fields of GetBalance

state_root_hash: Digest

The state root hash.

purse_uref: URef

The purse URef.

responder: Responder<Result<BalanceResult, Error>>

Responder to call with the result.

GetDeploy

Return the specified deploy and metadata if it exists, else None.

Fields of GetDeploy

hash: DeployHash

The hash of the deploy to be retrieved.

responder: Responder<Option<(Deploy, DeployMetadata<LinearBlock>)>>

Responder to call with the result.

GetPeers

Return the connected peers.

Fields of GetPeers

responder: Responder<HashMap<I, SocketAddr>>

Responder to call with the result.

GetStatus

Return string formatted status or None if an error occurred.

Fields of GetStatus

responder: Responder<StatusFeed>

Responder to call with the result.

GetMetrics

Return string formatted, prometheus compatible metrics or None if an error occurred.

Fields of GetMetrics

responder: Responder<Option<String>>

Responder to call with the result.

Trait Implementations

`impl<I: Debug> Debug for ApiRequest`[src]

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

`impl Display for ApiRequest`[src]

`fn fmt(&self, formatter: &mut Formatter<'_>) -> Result`[src]

`impl From<ApiRequest<KeyFingerprint>> for Event`[src]

`fn from(request: ApiRequest<KeyFingerprint>) -> Self`[src]

Auto Trait Implementations

`impl !RefUnwindSafe for ApiRequest`

`impl Send for ApiRequest where I: Send,`

`impl Sync for ApiRequest where I: Send,`

`impl Unpin for ApiRequest`

`impl !UnwindSafe for ApiRequest`

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &T`[src]

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

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

`pub fn from(t: T) -> T`[src]

`impl<T> FromBits<T> for T`[src]

`pub fn from_bits(other: T) -> T`[src]

`impl<T> Instrument for T`[src]

`fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T> Instrument for T`[src]

`fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`fn in_current_span(self) -> Instrumented<Self>`[src]

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

`pub fn into(self) -> U`[src]

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`pub default fn to_string(&self) -> String`[src]

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

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Enum casper_node::effect::requests::ApiRequest

Variants

Fields of SubmitDeploy

Fields of GetBlock

Fields of QueryGlobalState

Fields of QueryEraValidators

Fields of QueryProtocolData

Fields of GetBalance

Fields of GetDeploy

Fields of GetPeers

Fields of GetStatus

Fields of GetMetrics

Trait Implementations

impl<I: Debug> Debug for ApiRequest<I>[src]

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

impl<I> Display for ApiRequest<I>[src]

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result[src]

impl From<ApiRequest<KeyFingerprint>> for Event[src]

fn from(request: ApiRequest<KeyFingerprint>) -> Self[src]

Auto Trait Implementations

impl<I> !RefUnwindSafe for ApiRequest<I>

impl<I> Send for ApiRequest<I> where I: Send,

impl<I> Sync for ApiRequest<I> where I: Send,

impl<I> Unpin for ApiRequest<I>

impl<I> !UnwindSafe for ApiRequest<I>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

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

pub fn borrow(&self) -> &T[src]

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

pub fn borrow_mut(&mut self) -> &mut T[src]

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

pub fn from(t: T) -> T[src]

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

pub fn from_bits(other: T) -> T[src]

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

fn in_current_span(self) -> Instrumented<Self>[src]

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

fn in_current_span(self) -> Instrumented<Self>[src]

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

pub fn into(self) -> U[src]

impl<T> Same<T> for T

type Output = T

impl<T> ToString for T where T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

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

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T[src]

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>, [src]

fn with_current_subscriber(self) -> WithDispatch<Self>[src]

`impl<I: Debug> Debug for ApiRequest<I>`[src]

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

`impl<I> Display for ApiRequest<I>`[src]

`fn fmt(&self, formatter: &mut Formatter<'_>) -> Result`[src]

`impl From<ApiRequest<KeyFingerprint>> for Event`[src]

`fn from(request: ApiRequest<KeyFingerprint>) -> Self`[src]

`impl<I> !RefUnwindSafe for ApiRequest<I>`

`impl<I> Send for ApiRequest<I> where I: Send,`

`impl<I> Sync for ApiRequest<I> where I: Send,`

`impl<I> Unpin for ApiRequest<I>`

`impl<I> !UnwindSafe for ApiRequest<I>`

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

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &T`[src]

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

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

`pub fn from(t: T) -> T`[src]

`impl<T> FromBits<T> for T`[src]

`pub fn from_bits(other: T) -> T`[src]

`impl<T> Instrument for T`[src]

`fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T> Instrument for T`[src]

`fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`fn in_current_span(self) -> Instrumented<Self>`[src]

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

`pub fn into(self) -> U`[src]

`impl<T> Same<T> for T`

`type Output = T`

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`pub default fn to_string(&self) -> String`[src]

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

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

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

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

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

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

`pub fn vzip(self) -> V`

`impl<T> WithSubscriber for T`[src]

`fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,` [src]

`fn with_current_subscriber(self) -> WithDispatch<Self>`[src]