Trait swipl::term::TermGetable

pub unsafe trait TermGetable: Sized {
    // Required methods
    fn get(term: &Term<'_>) -> Option<Self>;
    fn name() -> &'static str;
}

Trait for getting data from a term reference.

Safety

This is marked unsafe because in order to do term getting, we must be sure that

• the term is created on the engine which is currently active
• the given context is a context for this engine

Not checking those preconditions results in undefined behavior. Therefore, care must be taken to ensure that get is actually safe.

The macro [term_getable!] provides a way to safely implement this trait by doing the precondition checks for you.

Required Methods

fn get(term: &Term<'_>) -> Option<Self>

Get data from a term reference.

You’d generally not use this directly, but rather, go through Term::get.

fn name() -> &'static str

Get the name of this data type for use in exception reporting.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl<'a> TermGetable for bool

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

impl<'a> TermGetable for f64

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

impl<'a> TermGetable for i64

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

impl<'a> TermGetable for u64

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

impl<'a> TermGetable for String

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

impl<'a> TermGetable for Vec<u8>

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

impl<T: ArcBlob> TermGetable for Arc<T>

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

impl<T: TermGetable> TermGetable for Vec<T>

fn get(term: &Term<'_>) -> Option<Self>

fn name() -> &'static str

Implementors

impl<'a> TermGetable for Atomable<'static>

impl<'a> TermGetable for Atom

impl<'a> TermGetable for Functor

impl<'a> TermGetable for Record

impl<'a> TermGetable for ReadablePrologStream<'a>

impl<'a> TermGetable for WritablePrologStream<'a>

impl<'a> TermGetable for PrologText

impl<'a> TermGetable for Nil