Struct apollo_client::conf::ApolloConfClient

source ·
pub struct ApolloConfClient { /* private fields */ }
Available on crate feature conf only.
Expand description

Apollo configuration apis client.

Implementations§

source§

impl ApolloConfClient

source

pub async fn cached_fetch( &self, request: CachedFetchRequest, ) -> ApolloClientResult<Properties>

通过带缓存的Http接口从Apollo读取配置。 Ref

source

pub async fn fetch( &self, request: FetchRequest, ) -> ApolloClientResult<FetchResponse>

通过不带缓存的Http接口从Apollo读取配置。 Ref

source

pub async fn notify( &self, request: NotifyRequest, ) -> ApolloClientResult<Vec<Notification>>

应用感知配置更新。 Ref

source

pub fn watch( &self, request: WatchRequest, ) -> impl Stream<Item = ApolloClientResult<HashMap<String, ApolloClientResult<FetchResponse>>>> + '_

Watch the multi namespaces change, and fetch namespaces configuration when changed.

Return the Stream implemented futures_core::Stream, and the return value of poll_next will never be None (Dead Loop).

The first poll_next will fetch all namespaces, the remained will only fetch changed namespaces.

§Panic

panic if request.namespace_names is empty.

§Example
use apollo_client::conf::{meta::IpValue, requests::WatchRequest, ApolloConfClient};
use cidr_utils::cidr::IpCidr;
use futures_util::{pin_mut, stream::StreamExt};
use std::{error::Error, str::FromStr};

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let client: ApolloConfClient = todo!();

    let stream = client.watch(WatchRequest {
        app_id: "SampleApp".to_string(),
        namespace_names: vec![
            "application.properties".into(),
            "application.json".into(),
            "application.yml".into(),
        ],
        ip: Some(IpValue::HostCidr(IpCidr::from_str("172.16.0.0/16")?)),
        ..Default::default()
    });

    pin_mut!(stream);

    // This is a dead loop, `next()` is returned when configuration has changed.
    while let Some(response) = stream.next().await {
        let _ = response?;
    }

    Ok(())
}

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
source§

impl<T> From<T> for T

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

source§

impl<T> Same for T

§

type Output = T

Should always be Self
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.
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