Struct PyASCIIObject

#[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,
}

Available on non-Py_LIMITED_API only.

Fields

ob_base: PyObject

length: Py_ssize_t

hash: Py_hash_t

Available on Py_3_11 or non-PyPy only.

state: u32

A bit field with various properties.

Rust doesn’t expose bitfields. So we have accessor functions for retrieving values.

Before 3.12: 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;

3.12 and 3.13: unsigned int interned:2; // SSTATE_* constants. unsigned int kind:3; // PyUnicode_*_KIND constants. unsigned int compact:1; unsigned int ascii:1; unsigned int statically_allocated:1; unsigned int :24;

3.14 and later: uint16_t interned; // SSTATE_* constants. unsigned short kind:3; // PyUnicode_*_KIND constants. unsigned short compact:1; unsigned short ascii:1; unsigned int statically_allocated:1; unsigned int :10;

wstr: *mut wchar_t

Available on non-Py_3_12 only.

Implementations

impl PyASCIIObject

Interacting with the bitfield is not actually well-defined, so we mark these APIs unsafe.

pub unsafe fn interned(&self) -> c_uint

Available on non-GraalPy and non-Py_3_14 only.

Get the interned field of the PyASCIIObject state bitfield.

Returns one of: SSTATE_NOT_INTERNED, SSTATE_INTERNED_MORTAL, SSTATE_INTERNED_IMMORTAL, or [SSTATE_INTERNED_IMMORTAL_STATIC].

pub unsafe fn set_interned(&mut self, val: c_uint)

Available on non-GraalPy and non-Py_3_14 only.

Set the interned field of the PyASCIIObject state bitfield.

Calling this function with an argument that is not SSTATE_NOT_INTERNED, SSTATE_INTERNED_MORTAL, SSTATE_INTERNED_IMMORTAL, or [SSTATE_INTERNED_IMMORTAL_STATIC] is invalid.

pub unsafe fn kind(&self) -> c_uint

Available on non-GraalPy and non-Py_3_14 only.

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.

pub unsafe fn set_kind(&mut self, val: c_uint)

Available on non-GraalPy and non-Py_3_14 only.

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.

pub unsafe fn compact(&self) -> c_uint

Available on non-GraalPy and non-Py_3_14 only.

Get the compact field of the PyASCIIObject state bitfield.

Returns either 0 or 1.

pub unsafe fn set_compact(&mut self, val: c_uint)

Available on non-GraalPy and non-Py_3_14 only.

Set the compact flag of the PyASCIIObject state bitfield.

Calling this function with an argument that is neither 0 nor 1 is invalid.

pub unsafe fn ascii(&self) -> c_uint

Available on non-GraalPy and non-Py_3_14 only.

Get the ascii field of the PyASCIIObject state bitfield.

Returns either 0 or 1.

pub unsafe fn set_ascii(&mut self, val: c_uint)

Available on non-GraalPy and non-Py_3_14 only.

Set the ascii flag of the PyASCIIObject state bitfield.

Calling this function with an argument that is neither 0 nor 1 is invalid.

pub unsafe fn ready(&self) -> c_uint

Available on non-GraalPy and non-Py_3_12 only.

Get the ready field of the PyASCIIObject state bitfield.

Returns either 0 or 1.

pub unsafe fn set_ready(&mut self, val: c_uint)

Available on non-GraalPy and non-Py_3_12 only.

Set the ready flag of the PyASCIIObject state bitfield.

Calling this function with an argument that is neither 0 nor 1 is invalid.