Struct eos_rs::api::overlay::OverlayLoadLease

pub struct OverlayLoadLease<const N: u32>(_);

This represents a promise to the compiler that while a reference to this struct exists, the overlay N is loaded.

This is used as a parameter in functions that need a given overlay to be loaded.

Dropping the lease does not unload an overlay, but you can use the Self::unload method on a lease to do so.

You can clone a lease, but you will have the responsibility to make sure the overlay is not unloaded while clone lease is in use too.

Implementations

impl<const N: u32> OverlayLoadLease<N>

pub fn acquire() -> Self

Gets a lease on a loaded overlay.

This is a runtime checked version of acquire_unchecked. It will panic if the overlay is not loaded.

Important

Even though this function is marked as safe, since it checks if the overlay is loaded, you still need to make sure the overlay is not unloaded during the lifetime of the returned object.

pub unsafe fn acquire_unchecked() -> Self

Gets a lease on a loaded overlay.

Safety

You need to make sure the overlay is actually loaded and won’t get unloaded during the lifetime of the returned object.

pub fn is_loaded() -> bool

Checks if the overlay is loaded.

pub unsafe fn load() -> Self

Loads the given overlay if it isn’t already loaded.

Safety

This will change how memory is mapped. You will need to make sure there are no conflicts with other overlays and that all memory currently referenced will still be valid after this call.

pub unsafe fn unload(self)

Unloads the overlay.

Safety

This will render all still existing leases on the overlay invalid. You need to make sure that all leases are dropped.

pub fn group_id() -> u32

Returns the group ID of the overlay. This supports all game builtin overlays. Panics if no mapping is known.

Trait Implementations

impl<const N: u32> Clone for OverlayLoadLease<N>

fn clone(&self) -> OverlayLoadLease<N>

Returns a copy of the value.

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

Performs copy-assignment from source.