Struct Object &nbsp; Copy item path

impl<T: DriverObject> Object<T>

pub fn project<'pin>( self: Pin<&'pin mut Self>, ) -> ObjectProjection<'__pin, T>

Pin-projects all fields of Self.

These fields are structurally pinned:

obj
sgt_lock
inner

These fields are not structurally pinned:

parent_resv_obj
sgt_res

impl<T: DriverObject> Object<T>

pub fn dev(&self) -> &Device<T::Driver>

Returns the Device that owns this GEM object.

pub fn vmap<const SIZE: usize>(&self) -> Result<VMapRef<'_, T, SIZE>>

Creates and returns a virtual kernel memory mapping for this object.

pub fn sg_table<'a>(&'a self, dev: &'a Device<Bound>) -> Result<&'a SGTable>

Creates (if necessary) and returns an immutable reference to a scatter-gather table of DMA pages for this object.

This will pin the object in memory. It is expected that dev should be a pointer to the same device::Device which self belongs to, otherwise this function will return Err(EINVAL).

pub fn new( dev: &Device<T::Driver>, size: usize, config: ObjectConfig<'_, T>, args: T::Args, ) -> Result<ARef<Self>>

Create a new shmem-backed DRM object of the given size.

Additional config options can be specified using config.

pub fn owned_vmap<const SIZE: usize>(&self) -> Result<VMapOwned<T, SIZE>>

Creates and returns an owned reference to a virtual kernel memory mapping for this object.

Trait Implementations§

impl<T: DriverObject> AllocImpl for Object<T>

const ALLOC_OPS: AllocOps

The C callback operations for this memory manager.

type Driver = <T as DriverObject>::Driver

The Driver implementation for this AllocImpl.

impl<T> AlwaysRefCounted for Object<T>
where Self: IntoGEMObject, T: DriverObject,

fn inc_ref(&self)

Increments the reference count on the object.

unsafe fn dec_ref(obj: NonNull<Self>)

Decrements the reference count on the object. Read more

impl<T: DriverObject> Deref for Object<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: DriverObject> DerefMut for Object<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

fn as_raw(&self) -> *mut drm_gem_object

Returns a reference to the raw drm_gem_object structure, which must be valid as long as this owning object is valid.

unsafe fn from_raw<'a>(obj: *mut drm_gem_object) -> &'a Self

Converts a pointer to a struct drm_gem_object into a reference to Self. Read more

impl<T: DriverObject> Send for Object<T>

impl<T: DriverObject> Sync for Object<T>

Auto Trait Implementations§

impl<T> !Freeze for Object<T>

impl<T> !RefUnwindSafe for Object<T>

impl<T> !UnsafeUnpin for Object<T>

impl<T> !UnwindSafe for Object<T>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> BaseObject for T
where T: IntoGEMObject,

fn size(&self) -> usize

Returns the size of the object in bytes.

fn create_handle<D, F>(&self, file: &File<F>) -> Result<u32>
where Self: AllocImpl<Driver = D>, D: Driver<Object = Self, File = F>, F: DriverFile<Driver = D>,

Creates a new handle for the object associated with a given File (or returns an existing one).

fn lookup_handle<D, F>(file: &File<F>, handle: u32) -> Result<ARef<Self>>
where Self: AllocImpl<Driver = D> + AlwaysRefCounted, D: Driver<Object = Self, File = F>, F: DriverFile<Driver = D>,

Looks up an object by its handle for a given File.

fn create_mmap_offset(&self) -> Result<u64>

Creates an mmap offset to map the object from userspace.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Init<T> for T

unsafe fn __init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> KnownSize for T

const MIN_SIZE: usize = const MIN_SIZE: usize = size_of::<T>();

Minimum size of this type known at compile-time.

const MIN_ALIGN: Alignment = const MIN_ALIGN: Alignment = Alignment::of::<T>();

Minimum alignment of this type known at compile-time.

fn size(_: *const T) -> usize

Get the size of an object of this type in bytes, with the metadata of the given pointer.

impl<T> PinInit<T> for T

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T, U, const N: u32> TryIntoBounded<T, N> for U
where T: Integer, U: TryInto<T>,