Struct tk::error::Obj

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

A smart pointer that points to a referece-counted, heap-allocated Tcl value.

Implementations

impl Obj

pub fn new() -> Obj

Creates a new, empty Obj on heap, with reference count 1.

pub unsafe fn from_raw(tcl_obj: *mut Tcl_Obj) -> Obj

Constructs an Obj from a raw pointer.

Safety

The raw pointer should be provided by Tcl’s callback, or previously obtained by Obj::as_ptr().

pub fn as_ptr(&self) -> *mut Tcl_Obj

Provides a raw pointer to the obj.

pub fn into_raw(self) -> *mut Tcl_Obj

Consumes the obj, returning the raw pointer. To avoid a memory leak the pointer must be converted back to an Obj using Obj::from_raw.

pub fn get_string(&self) -> String

Return an obj’s string representation. If the value’s MUTF string representation is invalid, the string representation is regenerated from the value’s internal representation.

pub fn invalidate_string_rep(&self)

Marks an obj’s string representation invalid and to free any storage associated with the old string representation.

pub fn is_empty(&self) -> bool

Test if tcl::Obj has no value. A newly created Obj is guaranteed to be dummy. An empty string is considered to be dummy.

Example

assert!( tcl::Obj::new().is_empty() );
assert!( tcl::Obj::from("").is_empty() );
assert!( !tcl::Obj::from("hello").is_empty() );

pub fn is_shared(&self) -> bool

Checks if the reference count of this obj is greater than 1.

pub fn clone_value(&self) -> Option<Obj>

Clones the underlying value of this obj.

impl Obj

pub fn as_bool(&self) -> bool

Returns a bool value of this obj. The values 0, “0”, false, “false”( case insensitive ) is considered as false. The values 1, “1”, true, “true”( case insensitive ) is considered as true. Other values will panic.

impl Obj

pub fn as_i8(&self) -> i8

impl Obj

pub fn as_i16(&self) -> i16

impl Obj

pub fn as_i32(&self) -> i32

impl Obj

pub fn as_i64(&self) -> i64

impl Obj

pub fn as_isize(&self) -> isize

impl Obj

pub fn as_u8(&self) -> u8

impl Obj

pub fn as_u16(&self) -> u16

impl Obj

pub fn as_u32(&self) -> u32

impl Obj

pub fn as_usize(&self) -> usize

impl Obj

pub fn as_f32(&self) -> f32

impl Obj

pub fn as_f64(&self) -> f64

impl Obj

pub fn new_dict() -> Obj

Creates a new, empty dictionary value.

Examples

use tcl::*;

let dict = Obj::new_dict();
assert_eq!( dict.to_string(), "" );

pub fn dict_get(&self, key: impl Into<Obj>) -> Result<Option<Obj>, NotDict>

Looks up the given key within the given dictionary and returns the value associated with that key, or None if the key has no mapping within the dictionary. An error of NotDict occurs if it cannot be converted to a dictionary.

Examples

use std::collections::HashMap;
use tcl::*;

let mut map = HashMap::new();
map.insert( "C"   , 1972 );
map.insert( "C++" , 1983 );
map.insert( "Rust", 2006 );

let map = Obj::from( map );
assert!( map.dict_get("Cpp").unwrap().is_none() );
assert_eq!( map.dict_get("Rust").unwrap().unwrap().as_i32(), 2006 );

pub fn dict_put( &self, key: impl Into<Obj>, value: impl Into<Obj> ) -> Result<(), Enum2<MutateSharedDict, NotDict>>

Updates the given dictionary so that the given key maps to the given value; any key may exist at most once in any particular dictionary. The dictionary must not be shared, or an error of MutateSharedDict will occur. An error of NotDict occurs if it cannot be converted to a dictionary.

Examples

use std::collections::HashMap;
use tcl::*;

let dict = Obj::new_dict();
assert_eq!( dict.to_string(), "" );

dict.dict_put( "Rust", 2006 );
assert_eq!( dict.to_string(), "Rust 2006" );

pub fn dict_remove( &self, key: impl Into<Obj> ) -> Result<(), Enum2<MutateSharedDict, NotDict>>

Updates the given dictionary so that the given key has no mapping to any value. The dictionary must not be shared, or an error of MutateSharedDict will occur. It is not an error if the key did not previously exist. An error of NotDict occurs if it cannot be converted to a dictionary.

Examples

use std::collections::HashMap;
use tcl::*;

let mut map = HashMap::new();
map.insert( "C++" , 1983 );
map.insert( "Rust", 2006 );

let map = Obj::from( map );
map.dict_remove("Cpp").unwrap();
map.dict_remove("C++").unwrap();
assert_eq!( map.to_string(), "Rust 2006" );

pub fn dict_size(&self) -> Result<i32, NotDict>

Updates the given variable with the number of key/value pairs currently in the given dictionary. An error of NotDict occurs if it cannot be converted to a dictionary.

Examples

use std::collections::HashMap;
use tcl::*;

let mut map = HashMap::new();
map.insert( "C++" , 1983 );
map.insert( "Rust", 2006 );
let map = Obj::from( map );
assert_eq!( map.dict_size().unwrap(), 2 );

let obj = vec![ "C++", "1983", "Rust", "2006" ];
assert_eq!( map.dict_size().unwrap(), 2 );

pub fn dict_iter(self) -> Result<DictIter, NotDict>

Creates an iterator from a dictionary.

Examples

use std::collections::HashMap;
use tcl::*;

let mut map = HashMap::new();
map.insert( "C"   , 1972 );
map.insert( "C++" , 1983 );
map.insert( "Rust", 2006 );
let map = Obj::from( map );
let mut list = map
    .dict_iter()
    .unwrap()
    .map( |(k,v)| (k.to_string(), v.as_i32() ))
    .collect::<Vec<_>>();
list.sort();
assert_eq!( list, vec![ ("C".to_owned(),1972), ("C++".to_owned(),1983), ("Rust".to_owned(),2006) ]);

impl Obj

pub fn new_list(objs: impl Iterator<Item = Obj>) -> Obj

Creates a new value as a Tcl list obj to hold objs.

pub fn new_list_with_capacity(cap: usize) -> Obj

Creates a new, empty Tcl list obj with the specified capacity.

pub fn set_list(self, objs: impl Iterator<Item = Obj>) -> Obj

Sets the obj to hold a Tcl list composed of objs.

pub fn list_append(&self, to_append: impl Into<Obj>) -> Result<(), NotList>

Append a list to_append to this list.

Examples

use tcl::*;
let list = Obj::from(( "The", "answer" ));
list.list_append(( "is", 42 ));
assert_eq!( list.to_string(), "The answer is 42" );

pub fn list_append_element(&self, elem: impl Into<Obj>) -> Result<(), NotList>

Append an element elem to this list.

Examples

use tcl::*;
let list = Obj::from(( "The", "answer" ));
list.list_append_element(( "is", 42 ));
assert_eq!( list.to_string(), "The answer {is 42}" );

pub fn get_elements(self) -> Result<impl Iterator<Item = Obj>, NotList>

Converts the list to an iterator that iterates over all its elements.

Examples

use tcl::*;
let list = Obj::from(( "The", "answer", "is", 42 ));
let mut elems = list.get_elements().unwrap();
assert_eq!( elems.next().unwrap().to_string(), "The" );
assert_eq!( elems.next().unwrap().to_string(), "answer" );
assert_eq!( elems.next().unwrap().to_string(), "is" );
assert_eq!( elems.next().unwrap().as_i32(), 42 );

pub fn list_length(&self) -> Result<i32, NotList>

Returns the amount of list elements.

Examples

use tcl::*;
let list = Obj::from(( "The", "answer", "is", 42 ));
assert_eq!( list.list_length().unwrap(), 4 );

pub fn list_index(&self, index: i32) -> Result<Option<Obj>, NotList>

Returns the nth obj in the list. Note that the index is 0-based.

Examples

use tcl::*;
let list = Obj::from(( "The", "answer", "is", 42 ));
assert_eq!( list.list_index(1).unwrap().unwrap().to_string(), "answer" );
assert!( list.list_index(4).unwrap().is_none() );

pub fn list_replace( &self, first: i32, count: i32, objs: impl Iterator<Item = Obj> ) -> Result<(), NotList>

Replace from the first to first+count objs in the list with objs.

If the argument first is zero or negative, it refers to the first element; if it is greater than or equal to the number of elements in the list, then no elements are deleted; the new elements are appended to the list.

If count is zero or negative then no elements are deleted; the new elements are simply inserted before the one designated by first.

Note that the index is 0-based.

Examples

use tcl::*;
let list = Obj::from(( "The", "answer", "is", 42 ));
let objs = vec![ "to", "life,", "the", "universe,", "and", "everything:" ].into_iter().map( Obj::from );
list.list_replace( 2, 1, objs ).unwrap();
assert_eq!( list.to_string(), "The answer to life, the universe, and everything: 42" );

Trait Implementations

impl Clone for Obj

fn clone(&self) -> Obj

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Obj

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

Formats the value using the given formatter.

impl Default for Obj

fn default() -> Obj

Returns the “default value” for a type.

impl Display for Obj

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

Formats the value using the given formatter.

impl Drop for Obj

fn drop(&mut self)

Executes the destructor for this type.

impl<T, O> From<&[T]> for Objwhere T: ToOwned<Owned = O>, O: Into<Obj>,

fn from(v: &[T]) -> Obj

Converts to this type from the input type.

impl<TK: TkInstance> From<&TtkStyle<TK>> for Obj

fn from(style: &TtkStyle<TK>) -> Obj

Converts to this type from the input type.

impl<'a> From<&'a str> for Obj

fn from(s: &'a str) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<Bitmap<Inst>> for Obj

fn from(bitmap: Bitmap<Inst>) -> Obj

Converts to this type from the input type.

impl From<CString> for Obj

fn from(s: CString) -> Obj

Converts to this type from the input type.

impl From<Column> for Obj

fn from(id: Column) -> Obj

Converts to this type from the input type.

impl<'a, B> From<Cow<'a, B>> for Objwhere B: 'a + ToOwned + ?Sized, &'a B: Into<Obj>, <B as ToOwned>::Owned: Into<Obj>,

fn from(cow: Cow<'a, B>) -> Obj

Converts to this type from the input type.

impl<'a, Opts> From<Font<'a, Opts>> for Objwhere Opts: IntoHomoTuple<TkFontOpt> + IntoHomoTuple<OptPair>,

fn from(font: Font<'a, Opts>) -> Obj

Converts to this type from the input type.

impl<K, V> From<HashMap<K, V>> for Objwhere K: Into<Obj>, V: Into<Obj>,

fn from(hash_map: HashMap<K, V>) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<Index> for Obj

fn from(index: Index) -> Obj

Converts to this type from the input type.

impl From<ItemId> for Obj

fn from(id: ItemId) -> Obj

Converts to this type from the input type.

impl From<ItemTag> for Obj

fn from(tag: ItemTag) -> Obj

Converts to this type from the input type.

impl<T> From<Option<T>> for Objwhere T: Into<Obj>,

fn from(option: Option<T>) -> Obj

Converts to this type from the input type.

impl From<PathBuf> for Obj

fn from(s: PathBuf) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<Photo<Inst>> for Obj

fn from(photo: Photo<Inst>) -> Obj

Converts to this type from the input type.

impl<T> From<Range<T>> for Objwhere T: Into<Obj>,

fn from(range: Range<T>) -> Obj

Converts to this type from the input type.

impl From<String> for Obj

fn from(s: String) -> Obj

Converts to this type from the input type.

impl From<Style> for Obj

fn from(style: Style) -> Obj

Converts to this type from the input type.

impl From<TagOrId> for Obj

fn from(tag_or_id: TagOrId) -> Obj

Converts to this type from the input type.

impl From<TkAcceptableSize> for Obj

fn from(acceptable_size: TkAcceptableSize) -> Obj

Converts to this type from the input type.

impl<'a, Inst: TkInstance> From<TkBindTag<'a, Inst>> for Obj

fn from(tag: TkBindTag<'a, Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkButton<Inst>> for Obj

fn from(widget: TkButton<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkCanvas<Inst>> for Obj

fn from(widget: TkCanvas<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkCheckbutton<Inst>> for Obj

fn from(widget: TkCheckbutton<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkCmp> for Obj

fn from(tk_cmp: TkCmp) -> Obj

Converts to this type from the input type.

impl<'a> From<TkColor<'a>> for Obj

fn from(color: TkColor<'a>) -> Obj

Converts to this type from the input type.

impl From<TkDistance> for Obj

fn from(distance: TkDistance) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkEntry<Inst>> for Obj

fn from(widget: TkEntry<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkEvent> for Obj

fn from(seq: TkEvent) -> Obj

Converts to this type from the input type.

impl From<TkEventSeq> for Obj

fn from(seq: TkEventSeq) -> Obj

Converts to this type from the input type.

impl From<TkFocusModel> for Obj

fn from(focus_model: TkFocusModel) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkFrame<Inst>> for Obj

fn from(widget: TkFrame<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkGeometry> for Obj

fn from(geometry: TkGeometry) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkLabel<Inst>> for Obj

fn from(widget: TkLabel<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkLabelframe<Inst>> for Obj

fn from(widget: TkLabelframe<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkListbox<Inst>> for Obj

fn from(widget: TkListbox<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkMenu<Inst>> for Obj

fn from(widget: TkMenu<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkMenuCloneType> for Obj

fn from(menu_clone_type: TkMenuCloneType) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkMenubutton<Inst>> for Obj

fn from(widget: TkMenubutton<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkMessage<Inst>> for Obj

fn from(widget: TkMessage<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkOptionMenu<Inst>> for Obj

fn from(widget: TkOptionMenu<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkPanedwindow<Inst>> for Obj

fn from(widget: TkPanedwindow<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkRGB> for Obj

fn from(rgb: TkRGB) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkRadiobutton<Inst>> for Obj

fn from(widget: TkRadiobutton<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkRequester> for Obj

fn from(who: TkRequester) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkScale<Inst>> for Obj

fn from(widget: TkScale<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkScaleCoord> for Obj

fn from(scale_coord: TkScaleCoord) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkScrollbar<Inst>> for Obj

fn from(widget: TkScrollbar<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkScrollbarDelta> for Obj

fn from(delta: TkScrollbarDelta) -> Obj

Converts to this type from the input type.

impl From<TkScrollbarElement> for Obj

fn from(element: TkScrollbarElement) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkSpinbox<Inst>> for Obj

fn from(widget: TkSpinbox<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkSpinboxInvokableElement> for Obj

fn from(element: TkSpinboxInvokableElement) -> Obj

Converts to this type from the input type.

impl From<TkState> for Obj

fn from(state: TkState) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkText<Inst>> for Obj

fn from(widget: TkText<Inst>) -> Obj

Converts to this type from the input type.

impl From<TkTextDump> for Obj

fn from(dump: TkTextDump) -> Obj

Converts to this type from the input type.

impl From<TkTextMarkGravity> for Obj

fn from(gravity: TkTextMarkGravity) -> Obj

Converts to this type from the input type.

impl From<TkTextSearch> for Obj

fn from(search: TkTextSearch) -> Obj

Converts to this type from the input type.

impl From<TkTextSearchAll> for Obj

fn from(search: TkTextSearchAll) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TkToplevel<Inst>> for Obj

fn from(widget: TkToplevel<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkButton<Inst>> for Obj

fn from(widget: TtkButton<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkCheckbutton<Inst>> for Obj

fn from(widget: TtkCheckbutton<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkCombobox<Inst>> for Obj

fn from(widget: TtkCombobox<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkEntry<Inst>> for Obj

fn from(widget: TtkEntry<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkFrame<Inst>> for Obj

fn from(widget: TtkFrame<Inst>) -> Obj

Converts to this type from the input type.

impl From<TtkInsertPos> for Obj

fn from(pos: TtkInsertPos) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkLabel<Inst>> for Obj

fn from(widget: TtkLabel<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkLabelframe<Inst>> for Obj

fn from(widget: TtkLabelframe<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkMenubutton<Inst>> for Obj

fn from(widget: TtkMenubutton<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkNotebook<Inst>> for Obj

fn from(widget: TtkNotebook<Inst>) -> Obj

Converts to this type from the input type.

impl<'w, TK: TkInstance> From<TtkNotebookTabId<'w, TK>> for Obj

fn from(id: TtkNotebookTabId<'w, TK>) -> Obj

Converts to this type from the input type.

impl<'w, TK: TkInstance> From<TtkPane<'w, TK>> for Obj

fn from(pane: TtkPane<'w, TK>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkPanedwindow<Inst>> for Obj

fn from(widget: TtkPanedwindow<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkProgressbar<Inst>> for Obj

fn from(widget: TtkProgressbar<Inst>) -> Obj

Converts to this type from the input type.

impl From<TtkProgressbarInterval> for Obj

fn from(interval: TtkProgressbarInterval) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkRadiobutton<Inst>> for Obj

fn from(widget: TtkRadiobutton<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkScale<Inst>> for Obj

fn from(widget: TtkScale<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkScrollbar<Inst>> for Obj

fn from(widget: TtkScrollbar<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkSeparator<Inst>> for Obj

fn from(widget: TtkSeparator<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkSizegrip<Inst>> for Obj

fn from(widget: TtkSizegrip<Inst>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkSpinbox<Inst>> for Obj

fn from(widget: TtkSpinbox<Inst>) -> Obj

Converts to this type from the input type.

impl From<TtkState> for Obj

fn from(state: TtkState) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<TtkTreeview<Inst>> for Obj

fn from(widget: TtkTreeview<Inst>) -> Obj

Converts to this type from the input type.

impl<Tup, HTup, MTup> From<Tup> for Objwhere Tup: IntoHomoTuple<Obj, Output = HTup>, HTup: MapHomoTuple<Obj, *mut Tcl_Obj, Output = MTup>, MTup: HomoTuple<*mut Tcl_Obj>,

fn from(tuple: Tup) -> Obj

Converts to this type from the input type.

impl<T> From<Vec<T>> for Objwhere T: Into<Obj>,

fn from(v: Vec<T>) -> Obj

Converts to this type from the input type.

impl<Inst: TkInstance> From<Widget<Inst>> for Obj

fn from(widget: Widget<Inst>) -> Obj

Converts to this type from the input type.

impl From<bool> for Obj

fn from(b: bool) -> Obj

Converts to this type from the input type.

impl From<char> for Obj

fn from(c: char) -> Obj

Converts to this type from the input type.

impl From<f64> for Obj

fn from(i: f64) -> Obj

Converts to this type from the input type.

impl From<i16> for Obj

fn from(i: i16) -> Obj

Converts to this type from the input type.

impl From<i32> for Obj

fn from(i: i32) -> Obj

Converts to this type from the input type.

impl From<i64> for Obj

fn from(i: i64) -> Obj

Converts to this type from the input type.

impl From<i8> for Obj

fn from(i: i8) -> Obj

Converts to this type from the input type.

impl From<isize> for Obj

fn from(i: isize) -> Obj

Converts to this type from the input type.

impl From<u16> for Obj

fn from(i: u16) -> Obj

Converts to this type from the input type.

impl From<u32> for Obj

fn from(i: u32) -> Obj

Converts to this type from the input type.

impl From<u64> for Obj

fn from(v: u64) -> Obj

Converts to this type from the input type.

impl From<u8> for Obj

fn from(i: u8) -> Obj

Converts to this type from the input type.

impl From<usize> for Obj

fn from(i: usize) -> Obj

Converts to this type from the input type.

impl TryFrom<Obj> for TtkState

type Error = TtkStateParseError

The type returned in the event of a conversion error.

fn try_from(obj: Obj) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<Obj> for Vec<T>where Obj: TryInto<T, Error = DeError>,

type Error = DeError

The type returned in the event of a conversion error.

fn try_from(obj: Obj) -> Result<Vec<T>, <Vec<T> as TryFrom<Obj>>::Error>

Performs the conversion.