Skip to content
YosoiDocs

NodeReference

yosoi.outcomes.NodeReference

class NodeReference(ImmutableModel):

Document-bound native location, without retaining document contents.

Attributes: document_id: Identity of the document required to interpret this reference. coordinate: Native location within that document; construction does not resolve it.

Source: python/yosoi/outcomes.py:479

Members below are declared on this class. Inherited Pydantic methods and generated constructor signatures are not expanded.

document_id: DocumentId
coordinate: NativeCoordinate
@classmethod
def new(cls, document_id: DocumentId, coordinate: NativeCoordinate) -> Self:

Pair a native location with the document needed to interpret it.

Args: document_id: Identity of the retained document. coordinate: Native location within that document.

Returns: A reference without resolving the coordinate or retaining document contents.

Raises: LocatorError: Supplied values cannot form a valid Rust node reference.

Source: python/yosoi/outcomes.py:498