org.bytedeco.tvm

Class FileSystem

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tvm.FileSystem

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dmlc::io")
 @Properties(inherit=tvm_runtime.class)
public class FileSystem
extends Pointer

\brief file system system interface

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FileSystem(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
FileInfo	GetPathInfo(URI path) \brief get information about a path
void	ListDirectory(URI path, FileInfo out_list) \brief list files in a directory
void	ListDirectoryRecursive(URI path, FileInfo out_list) \brief list files in a directory recursively using ListDirectory
Stream	Open(URI path, BytePointer flag)
Stream	Open(URI path, BytePointer flag, boolean allow_null) \brief open a stream
Stream	Open(URI path, String flag)
Stream	Open(URI path, String flag, boolean allow_null)
SeekStream	OpenForRead(URI path)
SeekStream	OpenForRead(URI path, boolean allow_null) \brief open a seekable stream for read

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystem

public FileSystem(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

GetPathInfo

@ByVal
public FileInfo GetPathInfo(@Const @ByRef
                                    URI path)

\brief get information about a path

Parameters:

path - the path to the file

Returns:

the information about the file

ListDirectory

public void ListDirectory(@Const @ByRef
                          URI path,
                          @StdVector
                          FileInfo out_list)

\brief list files in a directory

Parameters:

path - to the file

out_list - the output information about the files

ListDirectoryRecursive

public void ListDirectoryRecursive(@Const @ByRef
                                   URI path,
                                   @StdVector
                                   FileInfo out_list)

\brief list files in a directory recursively using ListDirectory

Parameters:

path - to the file

out_list - the output information about the files

Open

public Stream Open(@Const @ByRef
                   URI path,
                   @Cast(value="const char*")
                   BytePointer flag,
                   @Cast(value="bool")
                   boolean allow_null)

\brief open a stream

Parameters:

path - path to file

flag - can be "w", "r", "a

allow_null - whether NULL can be returned, or directly report error

Returns:

the created stream, can be NULL when allow_null == true and file do not exist

Open

public Stream Open(@Const @ByRef
                   URI path,
                   @Cast(value="const char*")
                   BytePointer flag)

Open

public Stream Open(@Const @ByRef
                   URI path,
                   String flag,
                   @Cast(value="bool")
                   boolean allow_null)

Open

public Stream Open(@Const @ByRef
                   URI path,
                   String flag)

OpenForRead

public SeekStream OpenForRead(@Const @ByRef
                              URI path,
                              @Cast(value="bool")
                              boolean allow_null)

\brief open a seekable stream for read

Parameters:

path - the path to the file

allow_null - whether NULL can be returned, or directly report error

Returns:

the created stream, can be NULL when allow_null == true and file do not exist

OpenForRead

public SeekStream OpenForRead(@Const @ByRef
                              URI path)