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),
    FullStateDumped(FullStateDump),
    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)

Tuple Fields

0: ExternalApiWireError

Can occur in response to any AdminRequest.

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

DnaRegistered(DnaHash)

Tuple Fields

0: DnaHash

The successful response to an AdminRequest::RegisterDna

AppInstalled(InstalledAppInfo)

Tuple Fields

0: 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.

AppBundleInstalled(InstalledAppInfo)

Tuple Fields

0: 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.

AppUninstalled

The succesful response to an AdminRequest::UninstallApp.

It means the App was uninstalled successfully.

CloneCellCreated(CellId)

Tuple Fields

0: CellId

The successful response to an AdminRequest::CreateCloneCell.

The response contains the CellId of the newly created clone.

AdminInterfacesAdded

The succesful response to an AdminRequest::AddAdminInterfaces.

It means the AdminInterfaces have successfully been added

AgentPubKeyGenerated(AgentPubKey)

Tuple Fields

0: AgentPubKey

The succesful response to an AdminRequest::GenerateAgentPubKey.

Contains a new AgentPubKey generated by the Keystore

DnasListed(Vec<DnaHash>)

Tuple Fields

0: Vec<DnaHash>

The successful response to an AdminRequest::ListDnas.

Contains a list of the hashes of all installed Dnas

CellIdsListed(Vec<CellId>)

Tuple Fields

0: Vec<CellId>

The succesful response to an AdminRequest::ListCellIds.

Contains a list of all the Cell ids in the conductor

EnabledAppsListed(Vec<InstalledAppId>)

Tuple Fields

0: Vec<InstalledAppId>

The succesful response to an AdminRequest::ListEnabledApps.

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

ActiveAppsListed(Vec<InstalledAppId>)

Tuple Fields

0: Vec<InstalledAppId>

👎 Deprecated:

alias for EnabledAppsListed

👎 Deprecated:

alias for EnabledAppsListed

AppsListed(Vec<InstalledAppInfo>)

Tuple Fields

0: Vec<InstalledAppInfo>

The succesful response to an AdminRequest::ListApps.

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

AppInterfaceAttached

Fields

port: u16

Networking port of the new AppInterfaceApi

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

AppInterfacesListed(Vec<u16>)

Tuple Fields

0: Vec<u16>

The list of attached app interfaces.

AppEnabled

Fields

app: InstalledAppInfo

errors: Vec<(CellId, String)>

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.

AppActivated

Fields

app: InstalledAppInfo

👎 Deprecated:

alias for AppEnabled

errors: Vec<(CellId, String)>

👎 Deprecated:

alias for AppEnabled

👎 Deprecated:

alias for AppEnabled

AppDisabled

The succesful response to an AdminRequest::DisableApp.

It means the App was disabled successfully.

AppStarted(bool)

Tuple Fields

0: 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

AppDeactivated

👎 Deprecated:

alias for AppDisabled

StateDumped(String)

Tuple Fields

0: 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.

FullStateDumped(FullStateDump)

Tuple Fields

0: 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.

AgentInfoAdded

The succesful response to an AdminRequest::AddAgentInfo.

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

AgentInfoRequested(Vec<AgentInfoSigned>)

Tuple Fields

0: Vec<AgentInfoSigned>

The succesful response to an AdminRequest::RequestAgentInfo.

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

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.