Skip to content
YosoiDocs

SurfaceRead

yosoi.surface.SurfaceRead

class SurfaceRead(Protocol):

Common pure reading contract; frame decoding and effects are capabilities.

Source: python/yosoi/surface.py:377

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

@property
def descriptor(self) -> Descriptor:

Return supported operations and source identity.

Source: python/yosoi/surface.py:381

@property
def observation(self) -> Observation:

Return immutable interpretation metadata.

Source: python/yosoi/surface.py:386

@property
def root_reference(self) -> Reference:

Return the full scope of this representation.

Source: python/yosoi/surface.py:391

def read(self, request: ReadRequest) -> ReadResult:

Read bounded evidence; unsupported or foreign requests raise SurfaceError.

Source: python/yosoi/surface.py:395