org.mozilla.mentat

Class RustResult

java.lang.Object

com.sun.jna.Structure

org.mozilla.mentat.RustResult

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

RustResult.ByReference, RustResult.ByValue

public class RustResult
extends com.sun.jna.Structure
implements Closeable

Represents a C struct containing a Pointers and String that map to a Rust Result. A RustResult will contain either an ok value, OR an err value, or neither - never both.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RustResult.ByReference
static class	RustResult.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
String	err
com.sun.jna.Pointer	ok

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
RustResult()

Method Summary

Modifier and Type	Method and Description
void	close()
protected List<String>	getFieldOrder() Return this Structure's field names in their proper order.
boolean	isFailure() Is there an error attached to this result?
boolean	isSuccess() Is there an value attached to this result

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ok

public com.sun.jna.Pointer ok

err

public String err

Constructor Detail

RustResult

public RustResult()

Method Detail

isSuccess

public boolean isSuccess()

Is there an value attached to this result

Returns:

true if a value is present, false otherwise

isFailure

public boolean isFailure()

Is there an error attached to this result?

Returns:

true is an error is present, false otherwise

getFieldOrder

protected List<String> getFieldOrder()

Description copied from class: com.sun.jna.Structure

Return this Structure's field names in their proper order. For example,

 protected List getFieldOrder() {
     return Arrays.asList(new String[] { ... });
 }
 

IMPORTANT When deriving from an existing Structure subclass, ensure that you augment the list provided by the superclass, e.g.

 protected List getFieldOrder() {
     List fields = new ArrayList(super.getFieldOrder());
     fields.addAll(Arrays.asList(new String[] { ... }));
     return fields;
 }
 

Field order must be explicitly indicated, since the field order as returned by Class.getFields() is not guaranteed to be predictable.

Specified by:

getFieldOrder in class com.sun.jna.Structure

Returns:

ordered list of field names

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException