Skip to main content

LStream

Struct LStream 

Source
pub struct LStream {
    pub file: Option<Box<dyn LuaFileHandle>>,
    pub close_fn: Option<fn(&mut LuaState) -> Result<usize, LuaError>>,
}
Expand description

Lua file handle stored as the typed payload of a LuaUserData.

C equivalent: typedef luaL_Stream LStream in liolib.c.

TODO(port): Phase B must arrange for LStream to live inside LuaUserData’s opaque payload. The userdata system needs a typed-access API, e.g. state.check_arg_typed_userdata::<LStream>(1, LUA_FILE_HANDLE)?.

TODO(port): file must be Option<RefCell<Box<dyn LuaFileOps>>> to allow interior-mutability borrow splitting between the file handle and LuaState.

Fields§

§file: Option<Box<dyn LuaFileHandle>>

OS file handle. None = incompletely opened (pre-file pattern). Concrete implementations are installed via GlobalState::file_open_hook (registered by lua-cli) to keep std::fs out of lua-stdlib.

§close_fn: Option<fn(&mut LuaState) -> Result<usize, LuaError>>

Close callback. None means the stream is closed. C: p->closef == NULL.

Implementations§

Source§

impl LStream

Source

pub fn is_closed(&self) -> bool

isclosed(p) in C: true when closef is NULL.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.