Enum holochain::conductor::api::AdminResponse[−][src]

pub enum AdminResponse {
Show 24 variants
    Error(ExternalApiWireError),
    DnaRegistered(HoloHash<Dna>),
    AppInstalled(InstalledAppInfo),
    AppBundleInstalled(InstalledAppInfo),
    AppUninstalled,
    CloneCellCreated(CellId),
    AdminInterfacesAdded,
    AgentPubKeyGenerated(HoloHash<Agent>),
    DnasListed(Vec<HoloHash<Dna>, Global>),
    CellIdsListed(Vec<CellId, Global>),
    EnabledAppsListed(Vec<String, Global>),
    ActiveAppsListed(Vec<String, Global>),
    AppsListed(Vec<InstalledAppInfo, Global>),
    AppInterfaceAttached {
        port: u16,
    },
    AppInterfacesListed(Vec<u16, Global>),
    AppEnabled {
        app: InstalledAppInfo,
        errors: Vec<(CellId, String), Global>,
    },
    AppActivated {
        app: InstalledAppInfo,
        errors: Vec<(CellId, String), Global>,
    },
    AppDisabled,
    AppStarted(bool),
    AppDeactivated,
    StateDumped(String),
    FullStateDumped(FullStateDump),
    AgentInfoAdded,
    AgentInfoRequested(Vec<AgentInfoSigned, Global>),
}

Expand description

Represents the possible responses to an AdminRequest and follows a general convention of noun_verb as opposed to the verb_noun of AdminRequest.

Will serialize as an object with any contents of the enum on a key data and the enum variant on a key type, e.g. { type: 'app_interface_attached', data: { port: 4000 } }

Variants

Error(ExternalApiWireError)

Can occur in response to any AdminRequest.

There has been an error during the handling of the request. See ExternalApiWireError for variants.

Tuple Fields of Error

0: ExternalApiWireError

DnaRegistered(HoloHash<Dna>)

The successful response to an AdminRequest::RegisterDna

Tuple Fields of DnaRegistered

0: HoloHash<Dna>

AppInstalled(InstalledAppInfo)

The successful response to an AdminRequest::InstallApp.

The resulting InstalledAppInfo contains the App id, the AppRoleIds and, most usefully, the new CellIds of the newly installed Dnas. See the InstalledAppInfo docs for details.

Tuple Fields of AppInstalled

0: InstalledAppInfo

AppBundleInstalled(InstalledAppInfo)

The successful response to an AdminRequest::InstallAppBundle.

The resulting InstalledAppInfo contains the App id, the AppRoleIds and, most usefully, the new CellIds of the newly installed Dnas. See the InstalledAppInfo docs for details.

Tuple Fields of AppBundleInstalled

0: InstalledAppInfo

AppUninstalled

The succesful response to an AdminRequest::UninstallApp.

It means the App was uninstalled successfully.

CloneCellCreated(CellId)

The successful response to an AdminRequest::CreateCloneCell.

The response contains the CellId of the newly created clone.

Tuple Fields of CloneCellCreated

0: CellId

AdminInterfacesAdded

The succesful response to an AdminRequest::AddAdminInterfaces.

It means the AdminInterfaces have successfully been added

AgentPubKeyGenerated(HoloHash<Agent>)

The succesful response to an AdminRequest::GenerateAgentPubKey.

Contains a new AgentPubKey generated by the Keystore

Tuple Fields of AgentPubKeyGenerated

0: HoloHash<Agent>

DnasListed(Vec<HoloHash<Dna>, Global>)

The successful response to an AdminRequest::ListDnas.

Contains a list of the hashes of all installed Dnas

Tuple Fields of DnasListed

0: Vec<HoloHash<Dna>, Global>

CellIdsListed(Vec<CellId, Global>)

The succesful response to an AdminRequest::ListCellIds.

Contains a list of all the Cell ids in the conductor

Tuple Fields of CellIdsListed

0: Vec<CellId, Global>

EnabledAppsListed(Vec<String, Global>)

The succesful response to an AdminRequest::ListEnabledApps.

Contains a list of all the active App ids in the conductor

Tuple Fields of EnabledAppsListed

0: Vec<String, Global>

ActiveAppsListed(Vec<String, Global>)

👎 Deprecated:

alias for EnabledAppsListed

Tuple Fields of ActiveAppsListed

0: Vec<String, Global>

👎 Deprecated:

alias for EnabledAppsListed

AppsListed(Vec<InstalledAppInfo, Global>)

The succesful response to an AdminRequest::ListApps.

Contains a list of the InstalledAppInfo of the installed Apps in the conductor

Tuple Fields of AppsListed

0: Vec<InstalledAppInfo, Global>

AppInterfaceAttached

The succesful response to an AdminRequest::AttachAppInterface.

AppInterfaceApi successfully attached. Contains the port number that was selected (if not specified) by Holochain for running this App interface

Fields of AppInterfaceAttached

port: u16

Networking port of the new AppInterfaceApi

AppInterfacesListed(Vec<u16, Global>)

The list of attached app interfaces.

Tuple Fields of AppInterfacesListed

0: Vec<u16, Global>

AppEnabled

The succesful response to an AdminRequest::EnableApp.

It means the App was enabled successfully. If it was possible to put the app in a Running state, it will be Running, otherwise it will be Paused.

Fields of AppEnabled

app: InstalledAppInfoerrors: Vec<(CellId, String), Global>

AppActivated

👎 Deprecated:

alias for AppEnabled

Fields of AppActivated

app: InstalledAppInfo

👎 Deprecated:

alias for AppEnabled

errors: Vec<(CellId, String), Global>

👎 Deprecated:

alias for AppEnabled

AppDisabled

The succesful response to an AdminRequest::DisableApp.

It means the App was disabled successfully.

AppStarted(bool)

The succesful response to an AdminRequest::StartApp.

The boolean determines whether or not the was actually started. If false, it was because the app was in a disabled state, or the app failed to start. TODO: add reason why app couldn’t start

Tuple Fields of AppStarted

0: bool

AppDeactivated

👎 Deprecated:

alias for AppDisabled

StateDumped(String)

The succesful response to an AdminRequest::DumpState.

The result contains a string of serialized JSON data which can be deserialized to access the full state dump, and inspect the source chain.

Tuple Fields of StateDumped

0: String

FullStateDumped(FullStateDump)

The succesful response to an AdminRequest::DumpFullState.

The result contains a string of serialized JSON data which can be deserialized to access the full state dump, and inspect the source chain.

Note that this result can be very big, as it’s requesting for the full database of the Cell.

Tuple Fields of FullStateDumped

0: FullStateDump

AgentInfoAdded

The succesful response to an AdminRequest::AddAgentInfo.

This means the agent info was successfully added to the peer store.

AgentInfoRequested(Vec<AgentInfoSigned, Global>)

The succesful response to an AdminRequest::RequestAgentInfo.

This is all the agent info that was found for the request.

Tuple Fields of AgentInfoRequested

0: Vec<AgentInfoSigned, Global>

Enum holochain::conductor::api::AdminResponse[−][src]

Variants

Tuple Fields of Error

Tuple Fields of DnaRegistered

Tuple Fields of AppInstalled

Tuple Fields of AppBundleInstalled

Tuple Fields of CloneCellCreated

Tuple Fields of AgentPubKeyGenerated

Tuple Fields of DnasListed

Tuple Fields of CellIdsListed

Tuple Fields of EnabledAppsListed

Tuple Fields of ActiveAppsListed

Tuple Fields of AppsListed

Fields of AppInterfaceAttached

Tuple Fields of AppInterfacesListed

Fields of AppEnabled

Fields of AppActivated

Tuple Fields of AppStarted

Tuple Fields of StateDumped

Tuple Fields of FullStateDumped

Tuple Fields of AgentInfoRequested

Trait Implementations

impl Debug for AdminResponse

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

impl<'de> Deserialize<'de> for AdminResponse

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

impl Serialize for AdminResponse

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

impl<'_> TryFrom<&'_ AdminResponse> for SerializedBytes

type Error = SerializedBytesError

pub fn try_from( t: &AdminResponse) -> Result<SerializedBytes, SerializedBytesError>

impl TryFrom<AdminResponse> for SerializedBytes

type Error = SerializedBytesError

pub fn try_from( t: AdminResponse) -> Result<SerializedBytes, SerializedBytesError>

impl TryFrom<SerializedBytes> for AdminResponse

type Error = SerializedBytesError

pub fn try_from( sb: SerializedBytes) -> Result<AdminResponse, SerializedBytesError>

Auto Trait Implementations

impl RefUnwindSafe for AdminResponse

impl Send for AdminResponse

impl Sync for AdminResponse

impl Unpin for AdminResponse

impl UnwindSafe for AdminResponse

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

fn type_id_compat(&self) -> TypeId

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

pub fn pointer_metadata( &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

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

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

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

pub unsafe fn drop(ptr: usize)

impl<T> Pointee for T

type Metadata = ()

impl<T> Same<T> for T

type Output = T

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

pub fn deserialize<D>(
deserializer: D
) -> Result<AdminResponse, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,

pub fn try_from(
t: &AdminResponse
) -> Result<SerializedBytes, SerializedBytesError>

pub fn try_from(
t: AdminResponse
) -> Result<SerializedBytes, SerializedBytesError>

pub fn try_from(
sb: SerializedBytes
) -> Result<AdminResponse, SerializedBytesError>

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

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

pub fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

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>,

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

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

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