Struct pyo3_ffi::PyASCIIObject
source · #[repr(C)]pub struct PyASCIIObject {
pub ob_base: PyObject,
pub length: Py_ssize_t,
pub hash: Py_hash_t,
pub state: u32,
pub wstr: *mut wchar_t,
}
Fields§
§ob_base: PyObject
§length: Py_ssize_t
§hash: Py_hash_t
§state: u32
A bit field with various properties.
Rust doesn’t expose bitfields. So we have accessor functions for retrieving values.
unsigned int interned:2; // SSTATE_* constants. unsigned int kind:3; // PyUnicode_*_KIND constants. unsigned int compact:1; unsigned int ascii:1; unsigned int ready:1; unsigned int :24;
wstr: *mut wchar_t
Implementations§
source§impl PyASCIIObject
impl PyASCIIObject
Interacting with the bitfield is not actually well-defined, so we mark these APIs unsafe.
sourcepub unsafe fn interned(&self) -> c_uint
pub unsafe fn interned(&self) -> c_uint
Get the interned
field of the PyASCIIObject
state bitfield.
Returns one of: SSTATE_NOT_INTERNED
, SSTATE_INTERNED_MORTAL
,
or SSTATE_INTERNED_IMMORTAL
.
sourcepub unsafe fn set_interned(&mut self, val: c_uint)
pub unsafe fn set_interned(&mut self, val: c_uint)
Set the interned
field of the PyASCIIObject
state bitfield.
Calling this function with an argument that is not SSTATE_NOT_INTERNED
,
SSTATE_INTERNED_MORTAL
, or SSTATE_INTERNED_IMMORTAL
is invalid.
sourcepub unsafe fn kind(&self) -> c_uint
pub unsafe fn kind(&self) -> c_uint
Get the kind
field of the PyASCIIObject
state bitfield.
Returns one of:
PyUnicode_WCHAR_KIND
,
PyUnicode_1BYTE_KIND
, PyUnicode_2BYTE_KIND
, or PyUnicode_4BYTE_KIND
.
sourcepub unsafe fn set_kind(&mut self, val: c_uint)
pub unsafe fn set_kind(&mut self, val: c_uint)
Set the kind
field of the PyASCIIObject
state bitfield.
Calling this function with an argument that is not
PyUnicode_WCHAR_KIND
,
PyUnicode_1BYTE_KIND
, PyUnicode_2BYTE_KIND
, or PyUnicode_4BYTE_KIND
is invalid.
sourcepub unsafe fn compact(&self) -> c_uint
pub unsafe fn compact(&self) -> c_uint
Get the compact
field of the PyASCIIObject
state bitfield.
Returns either 0
or 1
.
sourcepub unsafe fn set_compact(&mut self, val: c_uint)
pub unsafe fn set_compact(&mut self, val: c_uint)
Set the compact
flag of the PyASCIIObject
state bitfield.
Calling this function with an argument that is neither 0
nor 1
is invalid.
sourcepub unsafe fn ascii(&self) -> c_uint
pub unsafe fn ascii(&self) -> c_uint
Get the ascii
field of the PyASCIIObject
state bitfield.
Returns either 0
or 1
.
sourcepub unsafe fn set_ascii(&mut self, val: c_uint)
pub unsafe fn set_ascii(&mut self, val: c_uint)
Set the ascii
flag of the PyASCIIObject
state bitfield.
Calling this function with an argument that is neither 0
nor 1
is invalid.
sourcepub unsafe fn ready(&self) -> c_uint
pub unsafe fn ready(&self) -> c_uint
Get the ready
field of the PyASCIIObject
state bitfield.
Returns either 0
or 1
.
sourcepub unsafe fn set_ready(&mut self, val: c_uint)
pub unsafe fn set_ready(&mut self, val: c_uint)
Set the ready
flag of the PyASCIIObject
state bitfield.
Calling this function with an argument that is neither 0
nor 1
is invalid.