Skip to main content

ShellProtocol

uefi_raw::protocol::shell

Struct ShellProtocol 

Source 
#[repr(C)]
pub struct ShellProtocol {
Show 46 fields
    pub execute: unsafe extern "efiapi" fn(parent_image_handle: *const Handle, command_line: *const Char16, environment: *const *const Char16, status_code: *mut Status) -> Status,
    pub get_env: unsafe extern "efiapi" fn(name: *const Char16) -> *const Char16,
    pub set_env: unsafe extern "efiapi" fn(name: *const Char16, value: *const Char16, volatile: bool) -> Status,
    pub get_alias: unsafe extern "efiapi" fn(alias: *const Char16, volatile: bool) -> *const Char16,
    pub set_alias: unsafe extern "efiapi" fn(command: *const Char16, alias: *const Char16, replace: bool, volatile: bool) -> Status,
    pub get_help_text: unsafe extern "efiapi" fn(command: *const Char16, sections: *const Char16, help_text: *mut *mut Char16) -> Status,
    pub get_device_path_from_map: unsafe extern "efiapi" fn(mapping: *const Char16) -> *const DevicePathProtocol,
    pub get_map_from_device_path: unsafe extern "efiapi" fn(device_path: *mut *mut DevicePathProtocol) -> *const Char16,
    pub get_device_path_from_file_path: unsafe extern "efiapi" fn(path: *const Char16) -> *const DevicePathProtocol,
    pub get_file_path_from_device_path: unsafe extern "efiapi" fn(path: *const DevicePathProtocol) -> *const Char16,
    pub set_map: unsafe extern "efiapi" fn(device_path: *const DevicePathProtocol, mapping: *const Char16) -> Status,
    pub get_cur_dir: unsafe extern "efiapi" fn(file_system_mapping: *const Char16) -> *const Char16,
    pub set_cur_dir: unsafe extern "efiapi" fn(file_system: *const Char16, dir: *const Char16) -> Status,
    pub open_file_list: unsafe extern "efiapi" fn(path: *const Char16, open_mode: u64, file_list: *mut *mut ShellFileInfo) -> Status,
    pub free_file_list: unsafe extern "efiapi" fn(file_list: *const *const ShellFileInfo) -> Status,
    pub remove_dup_in_file_list: unsafe extern "efiapi" fn(file_list: *const *const ShellFileInfo) -> Status,
    pub batch_is_active: unsafe extern "efiapi" fn() -> bool,
    pub is_root_shell: unsafe extern "efiapi" fn() -> bool,
    pub enable_page_break: unsafe extern "efiapi" fn(),
    pub disable_page_break: unsafe extern "efiapi" fn(),
    pub get_page_break: unsafe extern "efiapi" fn() -> bool,
    pub get_device_name: unsafe extern "efiapi" fn(device_handle: Handle, flags: ShellDeviceNameFlags, language: *const Char8, best_device_name: *mut *mut Char16) -> Status,
    pub get_file_info: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> *const FileInfo,
    pub set_file_info: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, file_info: *const FileInfo) -> Status,
    pub open_file_by_name: unsafe extern "efiapi" fn(file_name: *const Char16, file_handle: *mut ShellFileHandle, open_mode: u64) -> Status,
    pub close_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> Status,
    pub create_file: unsafe extern "efiapi" fn(file_name: *const Char16, file_attribs: u64, file_handle: *mut ShellFileHandle) -> Status,
    pub read_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, read_size: *mut usize, buffer: *mut c_void) -> Status,
    pub write_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, buffer_size: *mut usize, buffer: *mut c_void) -> Status,
    pub delete_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> Status,
    pub delete_file_by_name: unsafe extern "efiapi" fn(file_name: *const Char16) -> Status,
    pub get_file_position: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, position: *mut u64) -> Status,
    pub set_file_position: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, position: u64) -> Status,
    pub flush_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> Status,
    pub find_files: unsafe extern "efiapi" fn(file_pattern: *const Char16, file_list: *mut *mut ShellFileInfo) -> Status,
    pub find_files_in_dir: unsafe extern "efiapi" fn(file_dir_handle: ShellFileHandle, file_list: *mut *mut ShellFileInfo) -> Status,
    pub get_file_size: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, size: *mut u64) -> Status,
    pub open_root: unsafe extern "efiapi" fn(device_path: *const DevicePathProtocol, file_handle: *mut ShellFileHandle) -> Status,
    pub open_root_by_handle: unsafe extern "efiapi" fn(device_handle: Handle, file_handle: *mut ShellFileHandle) -> Status,
    pub execution_break: Event,
    pub major_version: u32,
    pub minor_version: u32,
    pub register_guid_name: unsafe extern "efiapi" fn(guid: *const Guid, guid_name: *const Char16) -> Status,
    pub get_guid_name: unsafe extern "efiapi" fn(guid: *const Guid, guid_name: *mut *mut Char16) -> Status,
    pub get_guid_from_name: unsafe extern "efiapi" fn(guid_name: *const Char16, guid: *mut Guid) -> Status,
    pub get_env_ex: unsafe extern "efiapi" fn(name: *const Char16, attributes: *mut u32) -> *const Char16,

}
Expand description

Shell Protocol

Fields§

§execute: unsafe extern "efiapi" fn(parent_image_handle: *const Handle, command_line: *const Char16, environment: *const *const Char16, status_code: *mut Status) -> Status§get_env: unsafe extern "efiapi" fn(name: *const Char16) -> *const Char16§set_env: unsafe extern "efiapi" fn(name: *const Char16, value: *const Char16, volatile: bool) -> Status§get_alias: unsafe extern "efiapi" fn(alias: *const Char16, volatile: bool) -> *const Char16§set_alias: unsafe extern "efiapi" fn(command: *const Char16, alias: *const Char16, replace: bool, volatile: bool) -> Status§get_help_text: unsafe extern "efiapi" fn(command: *const Char16, sections: *const Char16, help_text: *mut *mut Char16) -> Status§get_device_path_from_map: unsafe extern "efiapi" fn(mapping: *const Char16) -> *const DevicePathProtocol§get_map_from_device_path: unsafe extern "efiapi" fn(device_path: *mut *mut DevicePathProtocol) -> *const Char16§get_device_path_from_file_path: unsafe extern "efiapi" fn(path: *const Char16) -> *const DevicePathProtocol§get_file_path_from_device_path: unsafe extern "efiapi" fn(path: *const DevicePathProtocol) -> *const Char16§set_map: unsafe extern "efiapi" fn(device_path: *const DevicePathProtocol, mapping: *const Char16) -> Status§get_cur_dir: unsafe extern "efiapi" fn(file_system_mapping: *const Char16) -> *const Char16§set_cur_dir: unsafe extern "efiapi" fn(file_system: *const Char16, dir: *const Char16) -> Status§open_file_list: unsafe extern "efiapi" fn(path: *const Char16, open_mode: u64, file_list: *mut *mut ShellFileInfo) -> Status§free_file_list: unsafe extern "efiapi" fn(file_list: *const *const ShellFileInfo) -> Status§remove_dup_in_file_list: unsafe extern "efiapi" fn(file_list: *const *const ShellFileInfo) -> Status§batch_is_active: unsafe extern "efiapi" fn() -> bool§is_root_shell: unsafe extern "efiapi" fn() -> bool§enable_page_break: unsafe extern "efiapi" fn()§disable_page_break: unsafe extern "efiapi" fn()§get_page_break: unsafe extern "efiapi" fn() -> bool§get_device_name: unsafe extern "efiapi" fn(device_handle: Handle, flags: ShellDeviceNameFlags, language: *const Char8, best_device_name: *mut *mut Char16) -> Status§get_file_info: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> *const FileInfo§set_file_info: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, file_info: *const FileInfo) -> Status§open_file_by_name: unsafe extern "efiapi" fn(file_name: *const Char16, file_handle: *mut ShellFileHandle, open_mode: u64) -> Status§close_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> Status§create_file: unsafe extern "efiapi" fn(file_name: *const Char16, file_attribs: u64, file_handle: *mut ShellFileHandle) -> Status§read_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, read_size: *mut usize, buffer: *mut c_void) -> Status§write_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, buffer_size: *mut usize, buffer: *mut c_void) -> Status§delete_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> Status§delete_file_by_name: unsafe extern "efiapi" fn(file_name: *const Char16) -> Status§get_file_position: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, position: *mut u64) -> Status§set_file_position: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, position: u64) -> Status§flush_file: unsafe extern "efiapi" fn(file_handle: ShellFileHandle) -> Status§find_files: unsafe extern "efiapi" fn(file_pattern: *const Char16, file_list: *mut *mut ShellFileInfo) -> Status§find_files_in_dir: unsafe extern "efiapi" fn(file_dir_handle: ShellFileHandle, file_list: *mut *mut ShellFileInfo) -> Status§get_file_size: unsafe extern "efiapi" fn(file_handle: ShellFileHandle, size: *mut u64) -> Status§open_root: unsafe extern "efiapi" fn(device_path: *const DevicePathProtocol, file_handle: *mut ShellFileHandle) -> Status§open_root_by_handle: unsafe extern "efiapi" fn(device_handle: Handle, file_handle: *mut ShellFileHandle) -> Status§execution_break: Event§major_version: u32§minor_version: u32§register_guid_name: unsafe extern "efiapi" fn(guid: *const Guid, guid_name: *const Char16) -> Status§get_guid_name: unsafe extern "efiapi" fn(guid: *const Guid, guid_name: *mut *mut Char16) -> Status§get_guid_from_name: unsafe extern "efiapi" fn(guid_name: *const Char16, guid: *mut Guid) -> Status§get_env_ex: unsafe extern "efiapi" fn(name: *const Char16, attributes: *mut u32) -> *const Char16

Implementations§

Trait Implementations§

Source§

impl Debug for ShellProtocol

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Send for ShellProtocol

§

impl !Sync for ShellProtocol

§

impl Freeze for ShellProtocol

§

impl RefUnwindSafe for ShellProtocol

§

impl Unpin for ShellProtocol

§

impl UnsafeUnpin for ShellProtocol

§

impl UnwindSafe for ShellProtocol

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> 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<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> 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, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.
§

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.
§

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

Performs the conversion.