MBrace.Core


ICloudFileStore

Namespace: MBrace.Core.Internals

Cloud file storage abstraction

Instance members

Instance memberDescription
BeginRead(path)
Signature: path:string -> Async<Stream>
Modifiers: abstract

Reads from an existing file in store. If successful returns a reader stream.

BeginWrite(path)
Signature: path:string -> Async<Stream>
Modifiers: abstract

Creates a new file in store. If successful returns a writer stream.

Combine(paths)
Signature: (paths:string []) -> string
Modifiers: abstract

Combines an array of paths into a path.

CreateDirectory(directory)
Signature: directory:string -> Async<unit>
Modifiers: abstract

Creates a new directory in store.

DefaultDirectory
Signature: string
Modifiers: abstract

Gets the default directory used by the current cluster.

CompiledName: get_DefaultDirectory

DeleteDirectory(...)
Signature: (directory:string * recursiveDelete:bool) -> Async<unit>
Modifiers: abstract

Deletes provided directory.

DeleteFile(path)
Signature: path:string -> Async<unit>
Modifiers: abstract

Deletes file in given path.

DirectoryExists(directory)
Signature: directory:string -> Async<bool>
Modifiers: abstract

Checks if directory exists in given path.

DownloadToLocalFile(...)
Signature: (cloudSourcePath:string * localTargetPath:string) -> Async<unit>
Modifiers: abstract

Downloads a cloud file to the specified path in the local disk.

DownloadToStream(path, stream)
Signature: (path:string * stream:Stream) -> Async<unit>
Modifiers: abstract

Downloads the contents of provided cloud file to specified write stream.

EnumerateDirectories(directory)
Signature: directory:string -> Async<string []>
Modifiers: abstract

Get all directories that exist in given directory.

EnumerateFiles(directory)
Signature: directory:string -> Async<string []>
Modifiers: abstract

Gets all files that exist in given container.

FileExists(path)
Signature: path:string -> Async<bool>
Modifiers: abstract

Checks if file exists in store.

GetDirectoryName(path)
Signature: path:string -> string
Modifiers: abstract

Returns the directory name for given path.

GetFileName(path)
Signature: path:string -> string
Modifiers: abstract

Returns the file name for given path.

GetFileSize(path)
Signature: path:string -> Async<int64>
Modifiers: abstract

Asynchronously gets the file size in bytes.

GetLastModifiedTime(path, isDirectory)
Signature: (path:string * isDirectory:bool) -> Async<DateTimeOffset>
Modifiers: abstract

Asynchronously gets the last modification time for given path.

GetRandomDirectoryName()
Signature: unit -> string
Modifiers: abstract

Generates a random, uniquely specified path to directory

Id
Signature: string
Modifiers: abstract

Store identifier

CompiledName: get_Id

IsCaseSensitiveFileSystem
Signature: bool
Modifiers: abstract

Indicates whether the file system uses case sensitive paths

CompiledName: get_IsCaseSensitiveFileSystem

IsPathRooted(path)
Signature: path:string -> bool
Modifiers: abstract

Returns true iff path is absolute under the store uri format.

Name
Signature: string
Modifiers: abstract

Implementation name

CompiledName: get_Name

ReadETag(path, etag)
Signature: (path:string * etag:ETag) -> Async<Stream option>
Modifiers: abstract

Attempts to begin reading file from given path, provided that supplied etag matches payload.

RootDirectory
Signature: string
Modifiers: abstract

Gets the root directory for cloud store instance.

CompiledName: get_RootDirectory

TryGetETag(path)
Signature: path:string -> Async<ETag option>
Modifiers: abstract

Asynchronously returns the ETag for provided file, if it exists.

UploadFromLocalFile(...)
Signature: (localSourcePath:string * cloudTargetPath:string) -> Async<unit>
Modifiers: abstract

Uploads a local file to specified path in the cloud file store.

UploadFromStream(path, stream)
Signature: (path:string * stream:Stream) -> Async<unit>
Modifiers: abstract

Uploads the contents of provided read stream to specified cloud file.

WithDefaultDirectory(directory)
Signature: directory:string -> ICloudFileStore
Modifiers: abstract

Creates a copy of the file store implementation with updated default directory.

WriteETag(path, writer)
Signature: (path:string * writer:(Stream -> Async<'R>)) -> Async<ETag * 'R>
Modifiers: abstract
Type parameters: 'R

Creates a new file in store. If successful returns a writer stream.

Fork me on GitHub