pub struct PtrMut<'a, A = Aligned>(/* private fields */)
where
A: IsAligned;
Expand description
Type-erased mutable borrow of some unknown type chosen when constructing this type.
This type tries to act “borrow-like” which means that:
- Pointer is considered exclusive and mutable. It cannot be cloned as this would lead to aliased mutability.
- It must always point to a valid value of whatever the pointee type is.
- The lifetime
'a
accurately represents how long the pointer is valid for. - If
A
isAligned
, the pointer must always be properly aligned for the unknown pointee type.
It may be helpful to think of this type as similar to &'a mut dyn Any
but without
the metadata and able to point to data that does not correspond to a Rust type.
Implementations§
Source§impl<'a> PtrMut<'a>
impl<'a> PtrMut<'a>
Sourcepub fn to_unaligned(self) -> PtrMut<'a, Unaligned>
pub fn to_unaligned(self) -> PtrMut<'a, Unaligned>
Removes the alignment requirement of this pointer
Source§impl<A> PtrMut<'_, A>where
A: IsAligned,
impl<A> PtrMut<'_, A>where
A: IsAligned,
Sourcepub unsafe fn byte_offset(self, count: isize) -> PtrMut<'_, A>
pub unsafe fn byte_offset(self, count: isize) -> PtrMut<'_, A>
Calculates the offset from a pointer.
As the pointer is type-erased, there is no size information available. The provided
count
parameter is in raw bytes.
See also: ptr::offset
§Safety
- The offset cannot make the existing ptr null, or take it out of bounds for its allocation.
- If the
A
type parameter isAligned
then the offset must not make the resulting pointer be unaligned for the pointee type. - The value pointed by the resulting pointer must outlive the lifetime of this pointer.
Sourcepub unsafe fn byte_add(self, count: usize) -> PtrMut<'_, A>
pub unsafe fn byte_add(self, count: usize) -> PtrMut<'_, A>
Calculates the offset from a pointer (convenience for .offset(count as isize)
).
As the pointer is type-erased, there is no size information available. The provided
count
parameter is in raw bytes.
See also: ptr::add
§Safety
- The offset cannot make the existing ptr null, or take it out of bounds for its allocation.
- If the
A
type parameter isAligned
then the offset must not make the resulting pointer be unaligned for the pointee type. - The value pointed by the resulting pointer must outlive the lifetime of this pointer.
Source§impl<'a, A> PtrMut<'a, A>where
A: IsAligned,
impl<'a, A> PtrMut<'a, A>where
A: IsAligned,
Sourcepub unsafe fn new(inner: NonNull<u8>) -> PtrMut<'a, A>
pub unsafe fn new(inner: NonNull<u8>) -> PtrMut<'a, A>
Creates a new instance from a raw pointer.
§Safety
inner
must point to valid value of whatever the pointee type is.- If the
A
type parameter isAligned
theninner
must be be properly aligned for the pointee type. inner
must have correct provenance to allow read and writes of the pointee type.- The lifetime
'a
must be constrained such that thisPtrMut
will stay valid and nothing else can read or mutate the pointee while thisPtrMut
is live.
Sourcepub unsafe fn deref_mut<T>(self) -> &'a mut T
pub unsafe fn deref_mut<T>(self) -> &'a mut T
Transforms this PtrMut<T>
into a &mut T
with the same lifetime
§Safety
T
must be the erased pointee type for thisPtrMut
.- If the type parameter
A
isUnaligned
then this pointer must be be properly aligned for the pointee typeT
.
Trait Implementations§
Auto Trait Implementations§
impl<'a, A> Freeze for PtrMut<'a, A>
impl<'a, A> RefUnwindSafe for PtrMut<'a, A>where
A: RefUnwindSafe,
impl<'a, A = Aligned> !Send for PtrMut<'a, A>
impl<'a, A = Aligned> !Sync for PtrMut<'a, A>
impl<'a, A> Unpin for PtrMut<'a, A>where
A: Unpin,
impl<'a, A = Aligned> !UnwindSafe for PtrMut<'a, A>
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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