Struct kube_client::api::ObjectList

pub struct ObjectList<T>
where
    T: Clone,
{
    pub types: TypeMeta,
    pub metadata: ListMeta,
    pub items: Vec<T>,
}

Available on crate feature client only.

A generic Kubernetes object list

This is used instead of a full struct for DeploymentList, PodList, etc. Kubernetes’ API always seem to expose list structs in this manner.

Note that this is only used internally within reflectors and informers, and is generally produced from list/watch/delete collection queries on an Resource.

This is almost equivalent to k8s_openapi::List<T>, but iterable.

Fields

types: TypeMeta

The type fields, always present

metadata: ListMeta

ListMeta - only really used for its resourceVersion

See ListMeta

items: Vec<T>

The items we are actually interested in. In practice; T := Resource<T,U>.

Implementations

impl<T> ObjectList<T>

where T: Clone,

pub fn iter(&self) -> impl Iterator<Item = &T>

iter returns an Iterator over the elements of this ObjectList

Example

use kube::api::{ListMeta, ObjectList, TypeMeta};
use k8s_openapi::api::core::v1::Pod;

let types: TypeMeta = TypeMeta::list::<Pod>();
let metadata: ListMeta = Default::default();
let items = vec![1, 2, 3];

let first = objectlist.iter().next();
println!("First element: {:?}", first); // prints "First element: Some(1)"

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

iter_mut returns an Iterator of mutable references to the elements of this ObjectList

Example

use kube::api::{ListMeta, ObjectList, TypeMeta};
use k8s_openapi::api::core::v1::Pod;

let types: TypeMeta = TypeMeta::list::<Pod>();
let metadata: ListMeta = Default::default();
let items = vec![1, 2, 3];

let mut first = objectlist.iter_mut().next();

// Reassign the value in first
if let Some(elem) = first {
    *elem = 2;
    println!("First element: {:?}", elem); // prints "First element: 2"
}

Trait Implementations

impl<T> Clone for ObjectList<T>

where T: Clone,

fn clone(&self) -> ObjectList<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ObjectList<T>

where T: Debug + Clone,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ObjectList<T>

where T: Clone, Vec<T>: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ObjectList<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, T> IntoIterator for &'a ObjectList<T>

where T: Clone,

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

type Item = &'a T

The type of the elements being iterated over.

fn into_iter(self) -> <&'a ObjectList<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut ObjectList<T>

where T: Clone,

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

type Item = &'a mut T

The type of the elements being iterated over.

fn into_iter(self) -> <&'a mut ObjectList<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for ObjectList<T>

where T: Clone,

type IntoIter = IntoIter<<ObjectList<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> <ObjectList<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> Serialize for ObjectList<T>

where T: Clone + Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.