pub struct PuppetProxy { /* private fields */ }

Implementations§

source§

impl PuppetProxy

source

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.archivist.test/Puppet.

source

pub fn take_event_stream(&self) -> PuppetEventStream

Get a Stream of events from the remote end of the protocol.

§Panics

Panics if the event stream was already taken.

source

pub fn set_health_ok(&self) -> QueryResponseFut<()>

Emits a health inspect node with OK status.

source

pub fn record_string(&self, key: &str, value: &str) -> QueryResponseFut<()>

Records a string inspect property.

source

pub fn record_int(&self, key: &str, value: i64) -> QueryResponseFut<()>

Records an integer inspect property.

source

pub fn emit_example_inspect_data(&self) -> QueryResponseFut<()>

Emits a collection of example of inspect data.

TODO(https://fuchsia.dev/302716196): Split this into several methods tests can call to explicitly emit the same data as this method.

source

pub fn println(&self, message: &str) -> QueryResponseFut<()>

Prints a message to stdout and appends a newline.

source

pub fn eprintln(&self, message: &str) -> QueryResponseFut<()>

Prints a message stderr and appends a newline.

source

pub fn log(&self, payload: &LogPuppetLogRequest) -> QueryResponseFut<()>

Emits a tracing event at the specified severity level.

source

pub fn wait_for_interest_change( &self ) -> QueryResponseFut<LogPuppetWaitForInterestChangeResponse>

Blocks the caller until the next time an interest change event is observed. Messages are lost if they are emitted using LogPuppet.Log before the puppet has observed the the interest change.

source

pub fn record_lazy_values( &self, key: &str ) -> QueryResponseFut<ClientEnd<LazyInspectPuppetMarker>>

Returns a LazyInspectPuppet client for recording lazy values.

source

pub fn crash(&self, message: &str) -> Result<(), Error>

Causes the puppet to crash with an optional error message.

The connection will be closed after this is called.

Trait Implementations§

source§

impl Clone for PuppetProxy

source§

fn clone(&self) -> PuppetProxy

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for PuppetProxy

source§

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

Formats the value using the given formatter. Read more
source§

impl Proxy for PuppetProxy

§

type Protocol = PuppetMarker

The protocol which this Proxy controls.
source§

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.
source§

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel. Read more
source§

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel. Read more
§

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end. Read more
§

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.
§

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.
source§

impl PuppetProxyInterface for PuppetProxy

§

type SetHealthOkResponseFut = QueryResponseFut<()>

source§

fn set_health_ok(&self) -> Self::SetHealthOkResponseFut

§

type RecordStringResponseFut = QueryResponseFut<()>

source§

fn record_string(&self, key: &str, value: &str) -> Self::RecordStringResponseFut

§

type RecordIntResponseFut = QueryResponseFut<()>

source§

fn record_int(&self, key: &str, value: i64) -> Self::RecordIntResponseFut

§

type EmitExampleInspectDataResponseFut = QueryResponseFut<()>

source§

fn emit_example_inspect_data(&self) -> Self::EmitExampleInspectDataResponseFut

§

type PrintlnResponseFut = QueryResponseFut<()>

source§

fn println(&self, message: &str) -> Self::PrintlnResponseFut

§

type EprintlnResponseFut = QueryResponseFut<()>

source§

fn eprintln(&self, message: &str) -> Self::EprintlnResponseFut

§

type LogResponseFut = QueryResponseFut<()>

source§

fn log(&self, payload: &LogPuppetLogRequest) -> Self::LogResponseFut

§

type WaitForInterestChangeResponseFut = QueryResponseFut<LogPuppetWaitForInterestChangeResponse>

source§

fn wait_for_interest_change(&self) -> Self::WaitForInterestChangeResponseFut

§

type RecordLazyValuesResponseFut = QueryResponseFut<ClientEnd<LazyInspectPuppetMarker>>

source§

fn record_lazy_values(&self, key: &str) -> Self::RecordLazyValuesResponseFut

source§

fn crash(&self, message: &str) -> Result<(), Error>

Auto Trait Implementations§

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
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more