Enum holochain_conductor_api::AdminResponse

pub enum AdminResponse {
    Error(ExternalApiWireError),
    DnaRegistered(DnaHash),
    AppInstalled(InstalledAppInfo),
    AppBundleInstalled(InstalledAppInfo),
    AppUninstalled,
    CloneCellCreated(CellId),
    AdminInterfacesAdded,
    AgentPubKeyGenerated(AgentPubKey),
    DnasListed(Vec<DnaHash>),
    CellIdsListed(Vec<CellId>),
    EnabledAppsListed(Vec<InstalledAppId>),
    ActiveAppsListed(Vec<InstalledAppId>),
    AppsListed(Vec<InstalledAppInfo>),
    AppInterfaceAttached {
        port: u16,
    },
    AppInterfacesListed(Vec<u16>),
    AppEnabled {
        app: InstalledAppInfo,
        errors: Vec<(CellId, String)>,
    },
    AppActivated {
        app: InstalledAppInfo,
        errors: Vec<(CellId, String)>,
    },
    AppDisabled,
    AppStarted(bool),
    AppDeactivated,
    StateDumped(String),
    AgentInfoAdded,
    AgentInfoRequested(Vec<AgentInfoSigned>),
}

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(DnaHash)

The successful response to an AdminRequest::RegisterDna

Tuple Fields of DnaRegistered

0: DnaHash

AppInstalled(InstalledAppInfo)

The successful response to an AdminRequest::InstallApp.

The resulting InstalledAppInfo contains the App id, the CellNicks 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 CellNicks 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(AgentPubKey)

The succesful response to an AdminRequest::GenerateAgentPubKey.

Contains a new AgentPubKey generated by the Keystore

Tuple Fields of AgentPubKeyGenerated

0: AgentPubKey

DnasListed(Vec<DnaHash>)

The successful response to an AdminRequest::ListDnas.

Contains a list of the hashes of all installed Dnas

Tuple Fields of DnasListed

0: Vec<DnaHash>

CellIdsListed(Vec<CellId>)

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>

EnabledAppsListed(Vec<InstalledAppId>)

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

ActiveAppsListed(Vec<InstalledAppId>)

👎 Deprecated:

alias for EnabledAppsListed

Tuple Fields of ActiveAppsListed

0: Vec<InstalledAppId>

👎 Deprecated:

alias for EnabledAppsListed

AppsListed(Vec<InstalledAppInfo>)

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>

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

The list of attached app interfaces.

Tuple Fields of AppInterfacesListed

0: Vec<u16>

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

AppActivated

👎 Deprecated:

alias for AppEnabled

Fields of AppActivated

app: InstalledAppInfo

👎 Deprecated:

alias for AppEnabled

errors: Vec<(CellId, String)>

👎 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

AgentInfoAdded

The succesful response to an AdminRequest::AddAgentInfo.

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

AgentInfoRequested(Vec<AgentInfoSigned>)

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>

Trait Implementations

impl Debug for AdminResponse

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Serialize for AdminResponse

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ AdminResponse> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<AdminResponse> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SerializedBytes> for AdminResponse

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.