module Bakelite

Included Modules

• Bakelite::DSL
• Bakelite::FS

Defined in:

bakelite.cr
bakelite/chunker.cr
bakelite/container/format.cr
bakelite/container/reader.cr
bakelite/container/writer.cr
bakelite/core/integrity_verifier.cr
bakelite/docs.cr
bakelite/docs/a_overview/introduction.cr
bakelite/docs/b_architecture/chunking_and_io.cr
bakelite/docs/c_dsl/macros_and_volumes.cr
bakelite/docs/d_containers/binary_containers.cr
bakelite/docs/e_scale/large_asset_streaming.cr
bakelite/docs/f_concurrency/thread_safety.cr
bakelite/dsl.cr
bakelite/dsl/verify_archive_builder.cr
bakelite/file_io.cr
bakelite/fs.cr
bakelite/glob.cr
bakelite/item.cr
bakelite/mime.cr
bakelite/transform/builtins.cr
bakelite/transform/cache.cr
bakelite/transform/runner.cr
bakelite/types.cr
bakelite/version.cr
bakelite/volume.cr
cli/main.cr

Constant Summary

COMMIT_VERSION = 9

MAJOR_VERSION = 0

MINOR_VERSION = 1

VERSION = "0.1.9"

Class Method Summary

• .[](path : String) : Bakelite::Item
• .[]?(path : String) : Bakelite::Item | Nil
• .carbon_version : Carbon::Version
• .content_manifest : Hash(String, String)
• .define_archive_verifier(&) : Core::IntegrityVerifier

  Constructs a configured Core::IntegrityVerifier without immediately executing it.

• .each_file(&block : Bakelite::Item -> ) : Nil
• .extract_all(destination_dir : Path | String, overwrite : Bool = true) : Int32
• .extract_folder(prefix : String, destination_dir : Path | String, overwrite : Bool = true) : Int32
• .extract_volume(name : Symbol | String, dest : Path | String, overwrite : Bool = true) : Int32

  Extracts an entire volume by name to destination directory.

• .extract_volume_folder(name : Symbol | String, prefix : String, dest : Path | String, overwrite : Bool = true) : Int32

  Extracts a specific subfolder from a volume to destination directory.

• .files : Array(String)
• .find_all_by_sha256(digest : String) : Array(Bakelite::Item)
• .find_by_sha256(digest : String) : Bakelite::Item | Nil
• .fs : Bakelite::FS::Registry

  Top-level global filesystem registry

• .get(path : String) : Bakelite::Item

  Direct lookups & routing

• .get?(path : String) : Bakelite::Item | Nil
• .get_by_sha256(digest : String) : Bakelite::Item
• .get_by_sha256?(digest : String) : Bakelite::Item | Nil
• .glob(pattern : String, &block : Bakelite::Item -> ) : Nil
• .glob(pattern : String) : Array(Bakelite::Item)
• .has_file?(path : String) : Bool
• .has_sha256?(digest : String) : Bool
• .manifest_sha256 : String
• .mount(volume : Bakelite::Volume) : Bakelite::Volume
• .mount_file(archive_path : String | Path, volume_name : Symbol | String | Nil = nil, mount : String | Nil = nil, priority : Int32 = 0) : Bakelite::Volume | Nil
• .mount_self!(priority : Int32 = 0) : Bool
• .open(path : String) : IO
• .open(path : String, &block : IO -> T) : T forall T
• .pack(target : Path | String, source_dir : Path | String, volume : Symbol | String = :root, mount_point : String = "", priority : Int32 = 0, chunk_size : UInt32 = 65536_u32, compression : CompressionType = CompressionType::Deflate, exclude : Array(String) = [] of String, append : Bool = true) : Int64

  Programmatic container packing API: packs a directory into a target container or appends to an executable.

• .pack(target : Path | String, volumes : Array(Volume), append : Bool = true) : Int64

  Programmatic container packing API: packs an array of preconfigured volumes into a target container.

• .pack_to_slice(volumes : Array(Volume)) : Bytes

  Packs an array of preconfigured volumes into an in-memory .bkl container byte slice.

• .unmount(volume_name : Symbol | String) : Bool
• .verify_archive(target : Bakelite::DSL::VerificationTarget | Nil = nil, raise_on_error : Bool = false, expected_digests : Hash(String, String) | Nil = nil, expected_manifest_sha256 : String | Nil = nil, strict : Bool = false) : Bakelite::Core::VerificationReport
• .verify_archive(target : Bakelite::DSL::VerificationTarget | Nil = nil, raise_on_error : Bool = false, &) : Bakelite::Core::VerificationReport
• .verify_archive!(target : Bakelite::DSL::VerificationTarget | Nil = nil, expected_digests : Hash(String, String) | Nil = nil, expected_manifest_sha256 : String | Nil = nil, strict : Bool = false) : Bakelite::Core::VerificationReport
• .verify_archive!(target : Bakelite::DSL::VerificationTarget | Nil = nil, &) : Bakelite::Core::VerificationReport
• .version : String
• .volume(name : Symbol | String) : Bakelite::Volume
• .volume(name : Symbol | String, mount : String = "", priority : Int32 = 0, &block : Bakelite::Volume -> ) : Bakelite::Volume
• .volume?(name : Symbol | String) : Bakelite::Volume | Nil
• .volumes : Array(Bakelite::Volume)

Class Method Detail