pub enum AdminResponse {
Show 26 variants
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),
NetworkMetricsDumped(String),
AgentInfoAdded,
AgentInfoRequested(Vec<AgentInfoSigned>),
ElementsAdded,
}
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.
DnaRegistered(DnaHash)
The successful response to an AdminRequest::RegisterDna
AppInstalled(InstalledAppInfo)
The successful response to an AdminRequest::InstallApp
.
The resulting InstalledAppInfo
contains the App id,
the AppRoleId
s and, most usefully, the new CellId
s
of the newly installed Dna
s. See the InstalledAppInfo
docs for details.
AppBundleInstalled(InstalledAppInfo)
The successful response to an AdminRequest::InstallAppBundle
.
The resulting InstalledAppInfo
contains the App id,
the AppRoleId
s and, most usefully, the new CellId
s
of the newly installed Dna
s. See the InstalledAppInfo
docs for details.
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.
AdminInterfacesAdded
The succesful response to an AdminRequest::AddAdminInterfaces
.
It means the AdminInterface
s have successfully been added
AgentPubKeyGenerated(AgentPubKey)
The succesful response to an AdminRequest::GenerateAgentPubKey
.
Contains a new AgentPubKey
generated by the Keystore
DnasListed(Vec<DnaHash>)
The successful response to an AdminRequest::ListDnas
.
Contains a list of the hashes of all installed Dna
s
CellIdsListed(Vec<CellId>)
The succesful response to an AdminRequest::ListCellIds
.
Contains a list of all the Cell
ids in the conductor
EnabledAppsListed(Vec<InstalledAppId>)
The succesful response to an AdminRequest::ListEnabledApps
.
Contains a list of all the active App
ids in the conductor
ActiveAppsListed(Vec<InstalledAppId>)
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
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>)
The list of attached app interfaces.
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.
AppActivated
Fields
app: InstalledAppInfo
alias for AppEnabled
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
AppDeactivated
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.
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.
NetworkMetricsDumped(String)
The successful result of a call to AdminRequest::DumpNetworkMetrics
.
The string is a json blob of the metrics results.
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.
ElementsAdded
Trait Implementations
sourceimpl Debug for AdminResponse
impl Debug for AdminResponse
sourceimpl<'de> Deserialize<'de> for AdminResponse
impl<'de> Deserialize<'de> for AdminResponse
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Serialize for AdminResponse
impl Serialize for AdminResponse
sourceimpl TryFrom<&'_ AdminResponse> for SerializedBytes
impl TryFrom<&'_ AdminResponse> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
sourcefn try_from(t: &AdminResponse) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(t: &AdminResponse) -> Result<SerializedBytes, SerializedBytesError>
Performs the conversion.
sourceimpl TryFrom<AdminResponse> for SerializedBytes
impl TryFrom<AdminResponse> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
sourcefn try_from(t: AdminResponse) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(t: AdminResponse) -> Result<SerializedBytes, SerializedBytesError>
Performs the conversion.
sourceimpl TryFrom<SerializedBytes> for AdminResponse
impl TryFrom<SerializedBytes> for AdminResponse
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
sourcefn try_from(sb: SerializedBytes) -> Result<AdminResponse, SerializedBytesError>
fn try_from(sb: SerializedBytes) -> Result<AdminResponse, SerializedBytesError>
Performs the conversion.
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: Any + ?Sized,
impl<T> Any for T where
T: Any + ?Sized,
fn type_id_compat(&self) -> TypeId
fn type_id_compat(&self) -> TypeId
TODO: once 1.33.0 is the minimum supported compiler version, remove Any::type_id_compat and use StdAny::type_id instead. https://github.com/rust-lang/rust/issues/27745 Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> FutureExt for T
impl<T> FutureExt for T
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn 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>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn 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>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more