Struct Span 

pub struct Span {
    pub file: String,
    pub bytes: Bytes,
    pub expanded_from: Option<Box<Span>>,
    pub included_from: Option<Box<Span>>,
}

A wrapper around scarf_syntax::Span, providing a location in the source code where a Node was found

Fields

file: String

The source file

bytes: Bytes

The byte-span within the source file

expanded_from: Option<Box<Span>>

The Span of the original token, if this is a text macro

included_from: Option<Box<Span>>

The Span of the `include directive that produced this one, if any

Implementations

impl Span

pub fn text(&self) -> PyResult<String>

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DerefToPyAny for Span

impl Eq for Span

impl<'a> From<Span<'a>> for Span

fn from(value: Span<'a>) -> Self

Converts to this type from the input type.

impl<'a, 'py> FromPyObject<'a, 'py> for Span

where Self: Clone,

const INPUT_TYPE: PyStaticExpr = <Span as ::pyo3::PyTypeInfo>::TYPE_HINT

Provides the type hint information for this type when it appears as an argument.

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for Span

const OUTPUT_TYPE: PyStaticExpr = <Span as ::pyo3::PyTypeInfo>::TYPE_HINT

Extracts the type hint information for this type when it appears as a return value.

type Target = Span

The Python output type

type Output = Bound<'py, <Span as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for Span

fn eq(&self, other: &Span) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PyClass for Span

const NAME: &str = "Span"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Span

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A wrapper around [`scarf_syntax::Span`], providing a location in the /// source code where a [`Node`] was found

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<Span as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<Span>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyMethods<Span> for PyClassImplCollector<Span>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Span

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

const TYPE_HINT: PyStaticExpr

Provides the full python type as a type hint.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl StructuralPartialEq for Span