Struct RpcApi

Source

pub struct RpcApi;

Expand description

RpcApi

Public, user-callable wrappers for Canic’s internal RPC workflows.

These functions:

form part of the public API surface
are safe to call from downstream canister lib.rs code
return PublicError suitable for IC boundaries

Internally, they delegate to workflow-level RPC implementations, preserving the layering:

user canister -> api -> workflow -> ops -> infra

Workflow returns internal [Error]; conversion to PublicError happens exclusively at this API boundary.

Implementations§

Source §

impl RpcApi

Source

pub async fn create_canister_request<A>( canister_role: &CanisterRole, parent: CreateCanisterParent, extra: Option<A>, ) -> Result<CreateCanisterResponse, PublicError>
where A: CandidType + Send + Sync,

Source

pub async fn upgrade_canister_request( canister_pid: Principal, ) -> Result<UpgradeCanisterResponse, PublicError>

Source

pub async fn response(request: Request) -> Result<Response, PublicError>

Auto Trait Implementations§

§

impl UnwindSafe for RpcApi

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

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> Same for T

Source §

type Output = T

Should always be Self

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

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

Source §

RpcApi

Struct RpcApi

Implementations§

impl RpcApi

pub async fn create_canister_request<A>( canister_role: &CanisterRole, parent: CreateCanisterParent, extra: Option<A>, ) -> Result<CreateCanisterResponse, PublicError>
where A: CandidType + Send + Sync,

pub async fn upgrade_canister_request( canister_pid: Principal, ) -> Result<UpgradeCanisterResponse, PublicError>

pub async fn response(request: Request) -> Result<Response, PublicError>

Auto Trait Implementations§

impl Freeze for RpcApi

impl RefUnwindSafe for RpcApi

impl Send for RpcApi

impl Sync for RpcApi

impl Unpin for RpcApi

impl UnwindSafe for RpcApi

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

impl<T> Same for T

type Output = T

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

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

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

fn vzip(self) -> V

RpcApi

Struct RpcApi Copy item path

Implementations§

impl RpcApi

pub async fn create_canister_request<A>( canister_role: &CanisterRole, parent: CreateCanisterParent, extra: Option<A>, ) -> Result<CreateCanisterResponse, PublicError>where A: CandidType + Send + Sync,

pub async fn upgrade_canister_request( canister_pid: Principal, ) -> Result<UpgradeCanisterResponse, PublicError>

pub async fn response(request: Request) -> Result<Response, PublicError>

Auto Trait Implementations§

impl Freeze for RpcApi

impl RefUnwindSafe for RpcApi

impl Send for RpcApi

impl Sync for RpcApi

impl Unpin for RpcApi

impl UnwindSafe for RpcApi

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same for T

type Output = T

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

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

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

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

fn vzip(self) -> V

Struct RpcApi

pub async fn create_canister_request<A>( canister_role: &CanisterRole, parent: CreateCanisterParent, extra: Option<A>, ) -> Result<CreateCanisterResponse, PublicError>
where A: CandidType + Send + Sync,

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

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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