Trait k8_client::metadata::MetadataClient

pub trait MetadataClient: Send + Sync {
    type MetadataClientError: MetadataClientError + From<Error> + From<DiffError> + From<Error> + Send + Display;
#[must_use]    fn retrieve_item<'life0, 'life1, 'async_trait, S, M>(
        &'life0 self, 
        metadata: &'life1 M
    ) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        M: K8Meta + Send + Sync + 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait;
#[must_use]    fn retrieve_items_with_option<'life0, 'async_trait, S, N>(
        &'life0 self, 
        namespace: N, 
        option: Option<ListArg>
    ) -> Pin<Box<dyn Future<Output = Result<K8List<S>, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        N: Into<NameSpace> + Send + Sync + 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait;
    fn retrieve_items_in_chunks<'a, S, N>(
        self: Arc<Self>, 
        namespace: N, 
        limit: u32, 
        option: Option<ListArg>
    ) -> Pin<Box<dyn Stream<Item = K8List<S>> + 'a + Send>>
    where
        N: Into<NameSpace> + Send + Sync + 'static,
        S: Spec + 'static;
#[must_use]    fn delete_item<'life0, 'life1, 'async_trait, S, M>(
        &'life0 self, 
        metadata: &'life1 M
    ) -> Pin<Box<dyn Future<Output = Result<K8Status, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        M: K8Meta + Send + Sync + 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait;
#[must_use]    fn create_item<'life0, 'async_trait, S>(
        &'life0 self, 
        value: K8SpecObj<S, InputObjectMeta>
    ) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait;
#[must_use]    fn update_status<'life0, 'life1, 'async_trait, S>(
        &'life0 self, 
        value: &'life1 UpdateK8ObjStatus<S>
    ) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait;
#[must_use]    fn patch_spec<'life0, 'life1, 'life2, 'async_trait, S, M>(
        &'life0 self, 
        metadata: &'life1 M, 
        patch: &'life2 Value
    ) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        M: K8Meta + Display + Send + Sync + 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait;
    fn watch_stream_since<S, N>(
        &self, 
        namespace: N, 
        resource_version: Option<String>
    ) -> Pin<Box<dyn Stream<Item = Result<Vec<Result<K8Watch<S>, Self::MetadataClientError>>, Self::MetadataClientError>> + Send>>
    where
        N: Into<NameSpace>,
        S: Spec + 'static;

#[must_use]    fn retrieve_items<'life0, 'async_trait, S, N>(
        &'life0 self, 
        namespace: N
    ) -> Pin<Box<dyn Future<Output = Result<K8List<S>, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        N: Into<NameSpace> + Send + Sync + 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait,
    { ... }
#[must_use]    fn apply<'life0, 'async_trait, S>(
        &'life0 self, 
        value: K8SpecObj<S, InputObjectMeta>
    ) -> Pin<Box<dyn Future<Output = Result<ApplyResult<S>, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait,
        Self::MetadataClientError: From<Error>,
        Self::MetadataClientError: From<DiffError>,
        Self::MetadataClientError: Send,
    { ... }
    fn watch_stream_now<S>(
        &self, 
        ns: String
    ) -> Pin<Box<dyn Stream<Item = Result<Vec<Result<K8Watch<S>, Self::MetadataClientError>>, Self::MetadataClientError>> + Send>>
    where
        S: Spec + 'static,
    { ... }
#[must_use]    fn exists<'life0, 'life1, 'async_trait, S, M>(
        &'life0 self, 
        metadata: &'life1 M
    ) -> Pin<Box<dyn Future<Output = Result<bool, Self::MetadataClientError>> + 'async_trait + Send>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        M: K8Meta + Display + Send + Sync + 'async_trait,
        S: Spec + 'async_trait,
        Self: 'async_trait,
    { ... }
}

Associated Types

type MetadataClientError: MetadataClientError + From<Error> + From<DiffError> + From<Error> + Send + Display

Loading content...

Required methods

#[must_use]fn retrieve_item<'life0, 'life1, 'async_trait, S, M>(
    &'life0 self,
    metadata: &'life1 M
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    M: K8Meta + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

retrieval a single item

#[must_use]fn retrieve_items_with_option<'life0, 'async_trait, S, N>(
    &'life0 self,
    namespace: N,
    option: Option<ListArg>
) -> Pin<Box<dyn Future<Output = Result<K8List<S>, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    N: Into<NameSpace> + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

fn retrieve_items_in_chunks<'a, S, N>(
    self: Arc<Self>,
    namespace: N,
    limit: u32,
    option: Option<ListArg>
) -> Pin<Box<dyn Stream<Item = K8List<S>> + 'a + Send>> where
    N: Into<NameSpace> + Send + Sync + 'static,
    S: Spec + 'static, 

returns stream of items in chunks

#[must_use]fn delete_item<'life0, 'life1, 'async_trait, S, M>(
    &'life0 self,
    metadata: &'life1 M
) -> Pin<Box<dyn Future<Output = Result<K8Status, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    M: K8Meta + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

#[must_use]fn create_item<'life0, 'async_trait, S>(
    &'life0 self,
    value: K8SpecObj<S, InputObjectMeta>
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

create new object

#[must_use]fn update_status<'life0, 'life1, 'async_trait, S>(
    &'life0 self,
    value: &'life1 UpdateK8ObjStatus<S>
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

update status

#[must_use]fn patch_spec<'life0, 'life1, 'life2, 'async_trait, S, M>(
    &'life0 self,
    metadata: &'life1 M,
    patch: &'life2 Value
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    M: K8Meta + Display + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

patch existing with spec

fn watch_stream_since<S, N>(
    &self,
    namespace: N,
    resource_version: Option<String>
) -> Pin<Box<dyn Stream<Item = Result<Vec<Result<K8Watch<S>, Self::MetadataClientError>>, Self::MetadataClientError>> + Send>> where
    N: Into<NameSpace>,
    S: Spec + 'static, 

stream items since resource versions

Loading content...

Provided methods

#[must_use]fn retrieve_items<'life0, 'async_trait, S, N>(
    &'life0 self,
    namespace: N
) -> Pin<Box<dyn Future<Output = Result<K8List<S>, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    N: Into<NameSpace> + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

retrieve all items a single chunk this may cause client to hang if there are too many items

#[must_use]fn apply<'life0, 'async_trait, S>(
    &'life0 self,
    value: K8SpecObj<S, InputObjectMeta>
) -> Pin<Box<dyn Future<Output = Result<ApplyResult<S>, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait,
    Self::MetadataClientError: From<Error>,
    Self::MetadataClientError: From<DiffError>,
    Self::MetadataClientError: Send, 

apply object, this is similar to kubectl apply for now, this doesn't do any optimization if object doesn't exist, it will be created if object exist, it will be patched by using strategic merge diff

fn watch_stream_now<S>(
    &self,
    ns: String
) -> Pin<Box<dyn Stream<Item = Result<Vec<Result<K8Watch<S>, Self::MetadataClientError>>, Self::MetadataClientError>> + Send>> where
    S: Spec + 'static, 

#[must_use]fn exists<'life0, 'life1, 'async_trait, S, M>(
    &'life0 self,
    metadata: &'life1 M
) -> Pin<Box<dyn Future<Output = Result<bool, Self::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    M: K8Meta + Display + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    Self: 'async_trait, 

Check if the object exists, return true or false.

Loading content...

Implementors

impl MetadataClient for DoNothingClient

type MetadataClientError = DoNothingError

fn retrieve_item<'life0, 'life1, 'async_trait, S, M>(
    &'life0 self,
    _metadata: &'life1 M
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, <DoNothingClient as MetadataClient>::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    M: K8Meta + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    K8Obj<S>: DeserializeOwned,
    DoNothingClient: 'async_trait, 

fn retrieve_items_with_option<'life0, 'async_trait, S, N>(
    &'life0 self,
    _namespace: N,
    _option: Option<ListArg>
) -> Pin<Box<dyn Future<Output = Result<K8List<S>, <DoNothingClient as MetadataClient>::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    N: Into<NameSpace> + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    DoNothingClient: 'async_trait, 

fn retrieve_items_in_chunks<'a, S, N>(
    self: Arc<DoNothingClient>,
    _namespace: N,
    _limit: u32,
    _option: Option<ListArg>
) -> Pin<Box<dyn Stream<Item = K8List<S>> + 'a + Send>> where
    N: Into<NameSpace> + Send + Sync + 'static,
    S: Spec + 'static, 

fn delete_item<'life0, 'life1, 'async_trait, S, M>(
    &'life0 self,
    _metadata: &'life1 M
) -> Pin<Box<dyn Future<Output = Result<K8Status, <DoNothingClient as MetadataClient>::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    M: K8Meta + Send + Sync + 'async_trait,
    S: Spec + 'async_trait,
    DoNothingClient: 'async_trait, 

fn create_item<'life0, 'async_trait, S>(
    &'life0 self,
    _value: K8SpecObj<S, InputObjectMeta>
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, <DoNothingClient as MetadataClient>::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    S: Spec + Send + 'async_trait,
    K8SpecObj<S, InputObjectMeta>: Serialize,
    K8SpecObj<S, InputObjectMeta>: Debug,
    K8Obj<S>: DeserializeOwned,
    DoNothingClient: 'async_trait, 

fn update_status<'life0, 'life1, 'async_trait, S>(
    &'life0 self,
    _value: &'life1 UpdateK8ObjStatus<S>
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, <DoNothingClient as MetadataClient>::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    S: Spec + Send + Sync + 'async_trait,
    UpdateK8ObjStatus<S>: Serialize,
    UpdateK8ObjStatus<S>: Debug,
    K8Obj<S>: DeserializeOwned,
    <S as Spec>::Status: Send,
    <S as Spec>::Status: Sync,
    DoNothingClient: 'async_trait, 

fn patch_spec<'life0, 'life1, 'life2, 'async_trait, S, M>(
    &'life0 self,
    _metadata: &'life1 M,
    _patch: &'life2 Value
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, <DoNothingClient as MetadataClient>::MetadataClientError>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    M: K8Meta + Display + Send + Sync + 'async_trait,
    S: Spec + Send + 'async_trait,
    K8Obj<S>: DeserializeOwned,
    DoNothingClient: 'async_trait, 

fn watch_stream_since<S, N>(
    &self,
    _namespace: N,
    _resource_version: Option<String>
) -> Pin<Box<dyn Stream<Item = Result<Vec<Result<K8Watch<S>, <DoNothingClient as MetadataClient>::MetadataClientError>>, <DoNothingClient as MetadataClient>::MetadataClientError>> + Send>> where
    N: Into<NameSpace>,
    S: Spec + Send + 'static,
    K8Watch<S>: DeserializeOwned,
    <S as Spec>::Header: Send,
    <S as Spec>::Header: 'static,
    <S as Spec>::Status: Send,
    <S as Spec>::Status: 'static, 

impl MetadataClient for K8Client

type MetadataClientError = ClientError

fn retrieve_item<'life0, 'life1, 'async_trait, S, M>(
    &'life0 self,
    metadata: &'life1 M
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, ClientError>> + Send + 'async_trait>> where
    S: Spec,
    M: K8Meta + Send + Sync,
    S: 'async_trait,
    M: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

retrieval a single item

fn retrieve_items_with_option<'life0, 'async_trait, S, N>(
    &'life0 self,
    namespace: N,
    option: Option<ListArg>
) -> Pin<Box<dyn Future<Output = Result<K8List<S>, ClientError>> + Send + 'async_trait>> where
    S: Spec,
    N: Into<NameSpace> + Send + Sync,
    S: 'async_trait,
    N: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

fn retrieve_items_in_chunks<'a, S, N>(
    self: Arc<Self>,
    namespace: N,
    limit: u32,
    option: Option<ListArg>
) -> BoxStream<'a, K8List<S>> where
    S: Spec + 'static,
    N: Into<NameSpace> + Send + Sync + 'static, 

fn delete_item<'life0, 'life1, 'async_trait, S, M>(
    &'life0 self,
    metadata: &'life1 M
) -> Pin<Box<dyn Future<Output = Result<K8Status, ClientError>> + Send + 'async_trait>> where
    S: Spec,
    M: K8Meta + Send + Sync,
    S: 'async_trait,
    M: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn create_item<'life0, 'async_trait, S>(
    &'life0 self,
    value: InputK8Obj<S>
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, ClientError>> + Send + 'async_trait>> where
    S: Spec,
    S: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

create new object

fn update_status<'life0, 'life1, 'async_trait, S>(
    &'life0 self,
    value: &'life1 UpdateK8ObjStatus<S>
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, ClientError>> + Send + 'async_trait>> where
    S: Spec,
    S: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

update status

fn patch_spec<'life0, 'life1, 'life2, 'async_trait, S, M>(
    &'life0 self,
    metadata: &'life1 M,
    patch: &'life2 Value
) -> Pin<Box<dyn Future<Output = Result<K8Obj<S>, ClientError>> + Send + 'async_trait>> where
    S: Spec,
    M: K8Meta + Display + Send + Sync,
    S: 'async_trait,
    M: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

patch existing with spec

fn watch_stream_since<S, N>(
    &self,
    namespace: N,
    resource_version: Option<String>
) -> BoxStream<'_, TokenStreamResult<S, Self::MetadataClientError>> where
    S: Spec + 'static,
    S::Status: 'static,
    S::Header: 'static,
    N: Into<NameSpace>, 

stream items since resource versions

Loading content...