pyo3::ffi

Struct PyASCIIObject

#[repr(C)]pub struct PyASCIIObject {
    pub ob_base: PyObject,
    pub length: isize,
    pub hash: isize,
    pub state: u32,
    pub wstr: *mut i32,
}

Fields§

§ob_base: PyObject§length: isize

Available on non-GraalPy only.

§hash: isize

Available on neither PyPy nor GraalPy.

§state: u32

Available on non-GraalPy only.

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 i32

Available on neither Py_3_12 nor GraalPy.

Implementations§

Source §

impl PyASCIIObject

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

Source

pub unsafe fn interned(&self) -> u32

Available on non-GraalPy 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].

Source

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

Available on non-GraalPy 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.

Source

pub unsafe fn kind(&self) -> u32

Available on non-GraalPy 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.

Source

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

Available on non-GraalPy 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.

Source

pub unsafe fn compact(&self) -> u32

Available on non-GraalPy only.

Get the compact field of the PyASCIIObject state bitfield.

Returns either 0 or 1.

Source

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

Available on non-GraalPy only.

Set the compact flag of the PyASCIIObject state bitfield.

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

Source

pub unsafe fn ascii(&self) -> u32

Available on non-GraalPy only.

Get the ascii field of the PyASCIIObject state bitfield.

Returns either 0 or 1.

Source

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

Available on non-GraalPy only.

Set the ascii flag of the PyASCIIObject state bitfield.

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

Source

pub unsafe fn ready(&self) -> u32

Available on non-GraalPy and non-Py_3_12 only.

Get the ready field of the PyASCIIObject state bitfield.

Returns either 0 or 1.

Source

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

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.

Auto Trait Implementations§

§

impl UnwindSafe for PyASCIIObject

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

Source §

const _CONDITION: usize = _

Source §

const _CHECK: &'static str = _

Source §

fn assert_not_zero_sized(&self)

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

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T> SizedTypeProperties for T

Source §

#[doc(hidden)] const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)

true if this type requires no storage. false if its size is greater than zero. Read more

Source §

#[doc(hidden)] const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)

Source §

impl<T> SomeWrap<T> for T

Source §

fn wrap(self) -> Option<T>

Source §

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Struct PyASCIIObjectCopy item path

Fields§

Implementations§

impl PyASCIIObject

pub unsafe fn interned(&self) -> u32

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

pub unsafe fn kind(&self) -> u32

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

pub unsafe fn compact(&self) -> u32

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

pub unsafe fn ascii(&self) -> u32

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

pub unsafe fn ready(&self) -> u32

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

Auto Trait Implementations§

impl Freeze for PyASCIIObject

impl RefUnwindSafe for PyASCIIObject

impl !Send for PyASCIIObject

impl !Sync for PyASCIIObject

impl Unpin for PyASCIIObject

impl UnwindSafe for PyASCIIObject

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T> AssertNotZeroSized for T

const _CONDITION: usize = _

const _CHECK: &'static str = _

fn assert_not_zero_sized(&self)

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> SizedTypeProperties for T

#[doc(hidden)] const IS_ZST: bool = _

#[doc(hidden)] const LAYOUT: Layout = _

impl<T> SomeWrap<T> for T

fn wrap(self) -> Option<T>

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

type Error = Infallible

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

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

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

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

Struct PyASCIIObject

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

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

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

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

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