Struct Symbol

pub struct Symbol(/* private fields */);

Represents a symbol.

This includes numbers, strings, functions (including constants when arguments are empty and tuples when the name is empty), #inf and #sup.

Implementations

impl Symbol

pub fn create_number(number: i32) -> Symbol

Construct a symbol representing a number.

pub fn create_supremum() -> Symbol

Construct a symbol representing #sup.

pub fn create_infimum() -> Symbol

Construct a symbol representing #inf

pub fn create_string(string: &str) -> Result<Symbol, ClingoError>

Construct a symbol representing a string.

Arguments

• string - the string

Errors:

• ClingoError::NulError - if string contains a nul byte
• ClingoError::InternalError with ErrorCode::BadAlloc

pub fn create_id(name: &str, positive: bool) -> Result<Symbol, ClingoError>

Construct a symbol representing an id.

Note: This is just a shortcut for Symbol::create_function() with empty arguments.

Arguments

• name - the name of the symbol
• positive - whether the symbol has a classical negation sign

Errors

• ClingoError::NulError - if name contains a nul byte
• ClingoError::InternalError with ErrorCode::BadAlloc

pub fn create_function( name: &str, arguments: &[Symbol], positive: bool, ) -> Result<Symbol, ClingoError>

Construct a symbol representing a function or tuple.

Note: To create tuples, the empty string has to be used as name.

Arguments

• name - the name of the function
• arguments - the arguments of the function
• positive - whether the symbol has a classical negation sign

Errors

• ClingoError::NulError - if name contains a nul byte
• ClingoError::InternalError with ErrorCode::BadAlloc

pub fn number(self) -> Result<i32, ClingoError>

Get the number of a symbol.

Errors

• ClingoError::InternalError with ErrorCode::Runtime if symbol is not of type SymbolType::Number

pub fn name(&self) -> Result<&'static str, ClingoError>

Get the name of a symbol.

Note: The string is internalized and valid for the duration of the process.

Errors

• ClingoError::InternalError with ErrorCode::Runtime
• ClingoError::Utf8Error

pub fn string(&self) -> Result<&'static str, ClingoError>

Get the string of a symbol.

Note: The string is internalized and valid for the duration of the process.

Errors

• ClingoError::InternalError with ErrorCode::Runtime if symbol is not of type SymbolType::String
• ClingoError::Utf8Error

pub fn is_positive(self) -> Result<bool, ClingoError>

Check if a function is positive (does not have a sign).

Errors

• ClingoError::InternalError with ErrorCode::Runtime

pub fn is_negative(self) -> Result<bool, ClingoError>

Check if a function is negative (has a sign).

Errors

• ClingoError::InternalError with ErrorCode::Runtime

pub fn arguments(self) -> Result<Vec<Symbol>, ClingoError>

Get the arguments of a symbol.

Errors

• ClingoError::InternalError with ErrorCode::Runtime

pub fn symbol_type(self) -> Result<SymbolType, ClingoError>

Get the type of a symbol.

Errors

• ClingoError::InternalError - may failed to match clingo symbol type

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Symbol

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Symbol> for clingo_symbol_t

fn from(symbol: Symbol) -> Self

Converts to this type from the input type.

impl From<u64> for Symbol

fn from(symbol: clingo_symbol_t) -> Self

Converts to this type from the input type.

impl FromSymbol for Symbol

type Error = Infallible

fn from_symbol(symbol: Symbol) -> Result<Self, Self::Error>

impl Hash for Symbol

fn hash<H: Hasher>(&self, state: &mut H)

Calculate a hash code of a symbol.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Symbol

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Symbol

fn partial_cmp(&self, other: &Symbol) -> Option<Ordering>

Compare two symbols.

Symbols are first compared by type. If the types are equal, the values are compared (where strings are compared using strcmp). Functions are first compared by signature and then lexicographically by arguments.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToSymbol for Symbol

fn symbol(&self) -> Result<Symbol, ClingoError>

impl Copy for Symbol

impl Eq for Symbol