Trait/Object

polynote.kernel

NotebookRef

Related Docs: object NotebookRef | package kernel

Permalink

trait NotebookRef extends AnyRef

A reference to a notebook in memory. If the notebook was loaded from a repository, making changes to the reference will cause the changes to be persisted in an implementation-dependent fashion.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NotebookRef
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addResult(cellID: CellID, result: Result): IO[AlreadyClosed, Unit]

    Permalink

    Append a Result to the given cell of the notebook

  2. abstract def awaitClosed: Task[Unit]

    Permalink

    Wait for the ref to be closed.

    Wait for the ref to be closed. Succeeds with Unit if the ref closes normally; fails with error otherwise

  3. abstract def clearAllResults(): IO[AlreadyClosed, List[CellID]]

    Permalink

    Clear results from all cells of the notebook, and return a list of CellIDs whose results were modified

  4. abstract def clearResults(cellID: CellID): IO[AlreadyClosed, Unit]

    Permalink

    Clear results from the given cell of the notebook

  5. abstract def close(): Task[Unit]

    Permalink

    Close the notebook.

  6. abstract def getVersioned: UIO[(Int, Notebook)]

    Permalink

    Return the latest version and notebook

  7. abstract def isOpen: UIO[Boolean]

    Permalink
  8. abstract def rename(newPath: String): RIO[BaseEnv with GlobalEnv, String]

    Permalink
  9. abstract def update(update: NotebookUpdate): IO[AlreadyClosed, Unit]

    Permalink

    Apply a notebook update.

    Apply a notebook update. If this NotebookRef is responsible for versioning, the version is incremented. The update may not be applied immediately; use updateAndGet to block until the update has been applied.

  10. abstract def updateAndGet(update: NotebookUpdate): IO[AlreadyClosed, (Int, Notebook)]

    Permalink

    Apply a notebook update and return the new version and notebook.

    Apply a notebook update and return the new version and notebook. If this NotebookRef is responsible for versioning, the version is incremented.

  11. abstract def updates: ZStream[Any, Throwable, NotebookUpdate]

    Permalink

    Get a stream of notebook updates

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def get: UIO[Notebook]

    Permalink

    Return the latest notebook

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. def path: UIO[String]

    Permalink
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped