blake library Null safety

Classes

Blake
Blake class ties together all commands and exports callable method for running this program.
BuildConfig
Configuration for building static site.
Content
Content symbolizes node in content tree. See Page or Section for concrete implementation.
Directory
A reference to a directory on the file system.
DirectoryServer
Serves local directory with given path as a web server.
ErrorCodes
Operating system error codes.
File
A reference to a file on the file system.
FileLock
Type of lock when requesting a lock on a file.
FileMode
The modes in which a File can be opened.
FileStat
The result of calling the POSIX stat() function on a file system object. [...]
FileSystem
A generic representation of a file system. [...]
FileSystemEntity
The common super class for io.File, io.Directory, and io.Link objects.
FileSystemEntityType
The type of an entity on the file system, such as a file, directory, or link. [...]
FileSystemEvent
Base event class emitted by FileSystemEntity.watch.
ForwardingDirectory<T extends Directory>
A directory that forwards all methods and properties to a delegate.
ForwardingFile
A file that forwards all methods and properties to a delegate.
ForwardingFileSystem
A file system that forwards all methods and properties to a delegate.
ForwardingFileSystemEntity<T extends FileSystemEntity, D extends FileSystemEntity>
A file system entity that forwards all methods and properties to a delegate.
A link that forwards all methods and properties to a delegate.
ForwardingRandomAccessFile
A RandomAccessFile implementation that forwards all methods and properties to a delegate.
IOSink
A combined byte and text output. [...]
A reference to a symbolic link on the file system.
LocalServer
Local web server used for blake serve command. [...]
RandomAccessFile
Random access to the data in a file. [...]
ServeConfig
Configuration specific to build serve command.
Shortcode
Shortcode is a single instance/usage of a shortcode inside Markdown file. Each shortcode has a name and zero or more arguments. [...]
ShortcodeParser
ShortcodeTemplate
ShortcodeTemplate is a single file inside templates/shortcodes folder. Shortcode template has a name which equals file name and a template which is this file's content.

Extensions

DirectoryExtension
FileSystemEntityExtension

Constants

fs → const LocalFileSystem
const LocalFileSystem()

Functions

getConfig() Future<Either<ConfigError, Config>>
Returns content of config.yaml file or throws when the file does not exists.
getContentDirectory(Config config) Future<Either<BuildError, Directory>>
Content directory contains Markdown files. [...]
getDataDirectory(Config config) Future<Directory>
getPublicDirectory(Config config) Future<Directory>
Public directory contains generated static files suitable for publishing. [...]
getStaticDirectory(Config config) Future<Directory>
Static folder contains files to be copied into public folder like CSS or JS. [...]
getTemplatesDirectory(Config config) Future<Directory>
Templates folder contains Jinja templates for rendering Markdown files inside content folder. [...]
isProjectDirectory() Future<bool>
parseAddress(String address, int port) Uri
Parse configured base_url. [...]

Exceptions / Errors

FileSystemException
Exception thrown when a file operation fails.
IOException
Base class for all IO related exceptions.
OSError
An Exception holding information about an error from the operating system.