Struct Locations

pub struct Locations { /* private fields */ }

Implements a client for the Cloud Metadata API.

Service Description

An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the Location.metadata field.

Configuration

Locations has various configuration parameters, the defaults should work with most applications.

Pooling and Cloning

Locations holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap Locations in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl Locations

pub async fn new() -> Result<Self>

Creates a new client with the default configuration.

pub async fn new_with_config(conf: ClientConfig) -> Result<Self>

Creates a new client with the specified configuration.

pub fn from_stub<T>(stub: T) -> Self

where T: Locations + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is when mocking the client.

pub fn list_locations(&self, name: impl Into<String>) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self, name: impl Into<String>) -> GetLocation

Gets information about a location.

Trait Implementations

impl Clone for Locations

fn clone(&self) -> Locations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Locations

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

Formats the value using the given formatter.