#[repr(C)]pub struct VZEFIVariableStore { /* private fields */ }
VZEFIVariableStore
only.Expand description
EFI variable store
The EFI variable store contains NVRAM variables exposed by the EFI ROM.
See also: VZEFIBootLoader
See also Apple’s documentation
Implementations§
Source§impl VZEFIVariableStore
impl VZEFIVariableStore
pub unsafe fn new() -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Sourcepub unsafe fn initWithURL(this: Allocated<Self>, url: &NSURL) -> Retained<Self>
pub unsafe fn initWithURL(this: Allocated<Self>, url: &NSURL) -> Retained<Self>
Initialize the variable store from the URL of an existing file.
Parameter URL
: The URL of the variable store on the local file system.
To create a new variable store, use -[VZEFIVariableStore initCreatingVariableStoreAtURL:options:error].
Sourcepub unsafe fn initCreatingVariableStoreAtURL_options_error(
this: Allocated<Self>,
url: &NSURL,
options: VZEFIVariableStoreInitializationOptions,
) -> Result<Retained<Self>, Retained<NSError>>
pub unsafe fn initCreatingVariableStoreAtURL_options_error( this: Allocated<Self>, url: &NSURL, options: VZEFIVariableStoreInitializationOptions, ) -> Result<Retained<Self>, Retained<NSError>>
Write an initialized VZEFIVariableStore to a URL on a file system.
Parameter URL
: The URL to write the variable store to on the local file system.
Parameter options
: Initialization options.
Parameter error
: If not nil, used to report errors if creation fails.
Returns: A newly initialized VZEFIVariableStore on success. If an error was encountered returns
nil,
and
error
contains the error.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
Dynamically find the class of this object.
§Panics
May panic if the object is invalid (which may be the case for objects
returned from unavailable init
/new
methods).
§Example
Check that an instance of NSObject
has the precise class NSObject
.
use objc2::ClassType;
use objc2::runtime::NSObject;
let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.Use Ivar::load
instead.
§Safety
The object must have an instance variable with the given name, and it
must be of type T
.
See Ivar::load_ptr
for details surrounding this.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Attempt to downcast the object to a class of type T
.
This is the reference-variant. Use Retained::downcast
if you want
to convert a retained object to another type.
§Mutable classes
Some classes have immutable and mutable variants, such as NSString
and NSMutableString
.
When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.
So using this method to convert a NSString
to a NSMutableString
,
while not unsound, is generally frowned upon unless you created the
string yourself, or the API explicitly documents the string to be
mutable.
See Apple’s documentation on mutability and on
isKindOfClass:
for more details.
§Generic classes
Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.
You can, however, safely downcast to generic collections where all the
type-parameters are AnyObject
.
§Panics
This works internally by calling isKindOfClass:
. That means that the
object must have the instance method of that name, and an exception
will be thrown (if CoreFoundation is linked) or the process will abort
if that is not the case. In the vast majority of cases, you don’t need
to worry about this, since both root objects NSObject
and
NSProxy
implement this method.
§Examples
Cast an NSString
back and forth from NSObject
.
use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};
let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();
Try (and fail) to cast an NSObject
to an NSString
.
use objc2_foundation::{NSObject, NSString};
let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());
Try to cast to an array of strings.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();
This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.
Downcast when processing each element instead.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
for elem in arr {
if let Some(data) = elem.downcast_ref::<NSString>() {
// handle `data`
}
}
Trait Implementations§
Source§impl AsRef<AnyObject> for VZEFIVariableStore
impl AsRef<AnyObject> for VZEFIVariableStore
Source§impl AsRef<NSObject> for VZEFIVariableStore
impl AsRef<NSObject> for VZEFIVariableStore
Source§impl AsRef<VZEFIVariableStore> for VZEFIVariableStore
impl AsRef<VZEFIVariableStore> for VZEFIVariableStore
Source§impl Borrow<AnyObject> for VZEFIVariableStore
impl Borrow<AnyObject> for VZEFIVariableStore
Source§impl Borrow<NSObject> for VZEFIVariableStore
impl Borrow<NSObject> for VZEFIVariableStore
Source§impl ClassType for VZEFIVariableStore
impl ClassType for VZEFIVariableStore
Source§const NAME: &'static str = "VZEFIVariableStore"
const NAME: &'static str = "VZEFIVariableStore"
Source§type ThreadKind = <<VZEFIVariableStore as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<VZEFIVariableStore as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for VZEFIVariableStore
impl Debug for VZEFIVariableStore
Source§impl Deref for VZEFIVariableStore
impl Deref for VZEFIVariableStore
Source§impl Hash for VZEFIVariableStore
impl Hash for VZEFIVariableStore
Source§impl Message for VZEFIVariableStore
impl Message for VZEFIVariableStore
Source§impl NSObjectProtocol for VZEFIVariableStore
impl NSObjectProtocol for VZEFIVariableStore
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref