Struct kube::runtime::reflector::ObjectRef

source ·
#[non_exhaustive]
pub struct ObjectRef<K>
where K: Lookup + ?Sized,
{ pub dyntype: <K as Lookup>::DynamicType, pub name: String, pub namespace: Option<String>, pub extra: Extra, }
Available on crate feature runtime only.
Expand description

A typed and namedspaced (if relevant) reference to a Kubernetes object

K may be either the object type or DynamicObject, in which case the type is stored at runtime. Erased ObjectRefs pointing to different types are still considered different.

use kube_runtime::reflector::ObjectRef;
use k8s_openapi::api::core::v1::{ConfigMap, Secret};
assert_ne!(
    ObjectRef::<ConfigMap>::new("a").erase(),
    ObjectRef::<Secret>::new("a").erase(),
);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§dyntype: <K as Lookup>::DynamicType§name: String

The name of the object

§namespace: Option<String>

The namespace of the object

May only be None if the kind is cluster-scoped (not located in a namespace). Note that it is acceptable for an ObjectRef to a cluster-scoped resource to have a namespace. These are, however, not considered equal:

assert_ne!(ObjectRef::<ConfigMap>::new("foo"), ObjectRef::new("foo").within("bar"));
§extra: Extra

Extra information about the object being referred to

This is not considered when comparing objects, but may be used when converting to and from other representations, such as OwnerReference or ObjectReference.

Implementations§

source§

impl<K> ObjectRef<K>
where K: Lookup, <K as Lookup>::DynamicType: Default,

source

pub fn new(name: &str) -> ObjectRef<K>

source

pub fn from_obj(obj: &K) -> ObjectRef<K>
where K: Lookup,

source§

impl<K> ObjectRef<K>
where K: Lookup,

source

pub fn new_with(name: &str, dyntype: <K as Lookup>::DynamicType) -> ObjectRef<K>

source

pub fn within(self, namespace: &str) -> ObjectRef<K>

source

pub fn from_obj_with( obj: &K, dyntype: <K as Lookup>::DynamicType, ) -> ObjectRef<K>
where K: Lookup,

Creates ObjectRef from the resource and dynamic type.

source

pub fn from_owner_ref( namespace: Option<&str>, owner: &OwnerReference, dyntype: <K as Lookup>::DynamicType, ) -> Option<ObjectRef<K>>

Create an ObjectRef from an OwnerReference

Returns None if the types do not match.

source

pub fn into_kind_unchecked<K2>( self, dt2: <K2 as Lookup>::DynamicType, ) -> ObjectRef<K2>
where K2: Lookup,

Convert into a reference to K2

Note that no checking is done on whether this conversion makes sense. For example, every Service has a corresponding Endpoints, but it wouldn’t make sense to convert a Pod into a Deployment.

source

pub fn erase(self) -> ObjectRef<DynamicObject>

Trait Implementations§

source§

impl<K> Clone for ObjectRef<K>
where K: Lookup + ?Sized, <K as Lookup>::DynamicType: Clone,

source§

fn clone(&self) -> ObjectRef<K>

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<K> Debug for ObjectRef<K>
where K: Lookup + ?Sized, <K as Lookup>::DynamicType: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<K> Display for ObjectRef<K>
where K: Lookup,

source§

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

Formats the value using the given formatter. Read more
source§

impl<K> From<ObjectRef<K>> for ReconcileRequest<K>
where K: Resource,

source§

fn from(obj_ref: ObjectRef<K>) -> ReconcileRequest<K>

Converts to this type from the input type.
source§

impl<K> Hash for ObjectRef<K>
where K: Lookup + ?Sized, <K as Lookup>::DynamicType: Hash,

source§

fn hash<__HK>(&self, __state: &mut __HK)
where __HK: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<K> PartialEq for ObjectRef<K>
where K: Lookup + ?Sized, <K as Lookup>::DynamicType: PartialEq,

source§

fn eq(&self, other: &ObjectRef<K>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<K> Eq for ObjectRef<K>
where K: Lookup + ?Sized, <K as Lookup>::DynamicType: Eq,

Auto Trait Implementations§

§

impl<K> Freeze for ObjectRef<K>
where <K as Lookup>::DynamicType: Freeze, K: ?Sized,

§

impl<K> RefUnwindSafe for ObjectRef<K>
where <K as Lookup>::DynamicType: RefUnwindSafe, K: ?Sized,

§

impl<K> Send for ObjectRef<K>
where <K as Lookup>::DynamicType: Send, K: ?Sized,

§

impl<K> Sync for ObjectRef<K>
where <K as Lookup>::DynamicType: Sync, K: ?Sized,

§

impl<K> Unpin for ObjectRef<K>
where <K as Lookup>::DynamicType: Unpin, K: ?Sized,

§

impl<K> UnwindSafe for ObjectRef<K>
where <K as Lookup>::DynamicType: UnwindSafe, K: ?Sized,

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

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

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

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

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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