Struct gcemeta::Client

source · [−]

pub struct Client<C, B = Body> { /* private fields */ }

Expand description

A Client to access metadata service.

Implementations

source

impl Client<(), Body>

source

pub fn new() -> Client<HttpConnector, Body>

Create a new Client with the default config.

source

impl<C, B> Client<C, B> where
 C: Connect + Clone + Send + Sync + 'static,
 B: HttpBody + Default + Send + 'static,
 B::Data: Send,
 B::Error: Into<Box<dyn Error + Send + Sync>>,

source

pub fn get(
 &self,
 path_and_query: PathAndQuery,
 trim: bool
) -> impl Future<Output = Result<String>> + Send + 'static

Get value from the metadata service.

source

pub fn get_as<T>(
 &self,
 path_and_query: PathAndQuery
) -> impl Future<Output = Result<T>> + Send + 'static where
 T: DeserializeOwned,

Get value from the metadata service.

source

pub async fn on_gce(&self) -> Result<bool>

Report whether this process is running on Google Compute Engine.

source

pub async fn project_id(&self) -> Result<String>

Get the current instance’s project ID string.

source

pub async fn numeric_project_id(&self) -> Result<String>

Get the current instance’s numeric project ID.

source

pub async fn internal_ip(&self) -> Result<String>

Get the instance’s primary internal IP address.

source

pub async fn external_ip(&self) -> Result<String>

Get the instance’s primary external (public) IP address.

source

pub async fn email(&self, sa: Option<&str>) -> Result<String>

Get service account’s email.

source

pub async fn hostname(&self) -> Result<String>

Get the instance’s hostname.

This will be of the form <instance_id>.c.<project_id>.internal.

source

pub async fn instance_tags(&self) -> Result<Vec<String>>

Get the list of user-defined instance tags, assigned when initially creating a GCE instance.

source

pub async fn instance_id(&self) -> Result<String>

Get the current VM’s numeric instance ID.

source

pub async fn instance_name(&self) -> Result<String>

Get the current VM’s instance ID string.

source

pub async fn zone(&self) -> Result<String>

Get the current VM’s zone, such as us-central1-b.

source

pub async fn instance_attrs(&self) -> Result<Vec<String>>

Get the list of user-defined attributes, assigned when initially creating a GCE VM instance.

source

pub async fn project_attrs(&self) -> Result<Vec<String>>

Get the list of user-defined attributes applying to the project as a whole, not just this VM.

source

pub async fn instance_attr(&self, attr: impl AsRef<str>) -> Result<String>

Get the value of the provided VM instance attribute.

source

pub async fn project_attr(&self, attr: impl AsRef<str>) -> Result<String>

Get the value of the provided project attribute.

source

pub async fn scopes(&self, sa: Option<&str>) -> Result<Vec<String>>

Get the service account scopes for the given account.

Trait Implementations

source

impl<C: Clone, B> Clone for Client<C, B>

source

fn clone(&self) -> Self

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<C, B> Debug for Client<C, B>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<C, B = Body> !RefUnwindSafe for Client<C, B>

impl<C, B> Send for Client<C, B> where
B: Send,
C: Send,

impl<C, B> Sync for Client<C, B> where
B: Send,
C: Sync,

impl<C, B> Unpin for Client<C, B> where
C: Unpin,

impl<C, B = Body> !UnwindSafe for Client<C, B>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

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 for T where
U: From<T>,

const: unstable · 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.

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct gcemeta::Client

Implementations

impl Client<(), Body>

pub fn new() -> Client<HttpConnector, Body>

impl<C, B> Client<C, B> where C: Connect + Clone + Send + Sync + 'static, B: HttpBody + Default + Send + 'static, B::Data: Send, B::Error: Into<Box<dyn Error + Send + Sync>>,

pub fn get( &self, path_and_query: PathAndQuery, trim: bool) -> impl Future<Output = Result<String>> + Send + 'static

pub fn get_as<T>( &self, path_and_query: PathAndQuery) -> impl Future<Output = Result<T>> + Send + 'static where T: DeserializeOwned,

pub async fn on_gce(&self) -> Result<bool>

pub async fn project_id(&self) -> Result<String>

pub async fn numeric_project_id(&self) -> Result<String>

pub async fn internal_ip(&self) -> Result<String>

pub async fn external_ip(&self) -> Result<String>

pub async fn email(&self, sa: Option<&str>) -> Result<String>

pub async fn hostname(&self) -> Result<String>

pub async fn instance_tags(&self) -> Result<Vec<String>>

pub async fn instance_id(&self) -> Result<String>

pub async fn instance_name(&self) -> Result<String>

pub async fn zone(&self) -> Result<String>

pub async fn instance_attrs(&self) -> Result<Vec<String>>

pub async fn project_attrs(&self) -> Result<Vec<String>>

pub async fn instance_attr(&self, attr: impl AsRef<str>) -> Result<String>

pub async fn project_attr(&self, attr: impl AsRef<str>) -> Result<String>

pub async fn scopes(&self, sa: Option<&str>) -> Result<Vec<String>>

Trait Implementations

impl<C: Clone, B> Clone for Client<C, B>

fn clone(&self) -> Self

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

impl<C, B> Debug for Client<C, B>

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

Auto Trait Implementations

impl<C, B = Body> !RefUnwindSafe for Client<C, B>

impl<C, B> Send for Client<C, B> where B: Send, C: Send,

impl<C, B> Sync for Client<C, B> where B: Send, C: Sync,

impl<C, B> Unpin for Client<C, B> where C: Unpin,

impl<C, B = Body> !UnwindSafe for Client<C, B>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<C, B> Client<C, B> where
C: Connect + Clone + Send + Sync + 'static,
B: HttpBody + Default + Send + 'static,
B::Data: Send,
B::Error: Into<Box<dyn Error + Send + Sync>>,

pub fn get(
&self,
path_and_query: PathAndQuery,
trim: bool
) -> impl Future<Output = Result<String>> + Send + 'static

pub fn get_as<T>(
&self,
path_and_query: PathAndQuery
) -> impl Future<Output = Result<T>> + Send + 'static where
T: DeserializeOwned,

impl<C, B> Send for Client<C, B> where
B: Send,
C: Send,

impl<C, B> Sync for Client<C, B> where
B: Send,
C: Sync,

impl<C, B> Unpin for Client<C, B> where
C: Unpin,

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

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> ToOwned for T where
T: Clone,

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

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

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