oaspec - v0.11.0

oaspec/codegen/writer

Types

WriteError

</>

Errors that can occur during file writing.

pub type WriteError {
  DirectoryCreateError(path: String, detail: String)
  FileWriteError(path: String, detail: String)
}

Constructors 

  • DirectoryCreateError(path: String, detail: String)
  • FileWriteError(path: String, detail: String)

Values

error_to_string

</> 
pub fn error_to_string(error: WriteError) -> String

Convert a write error to a human-readable string.

generate_all

</> 
pub fn generate_all(
  ctx: context.Context,
  on_write: fn(String) -> Nil,
) -> Result(List(String), WriteError)

Generate and write all files based on configuration.

output_dirs

</> 
pub fn output_dirs(cfg: config.Config) -> List(String)

Return the output directories that would be written to for the given config.

resolve_paths

</> 
pub fn resolve_paths(
  files: List(context.GeneratedFile),
  cfg: config.Config,
) -> List(#(String, String))

Resolve generated files to their full output paths and content. Used by –check to compare against existing files without writing.

write_all

</> 
pub fn write_all(
  files: List(context.GeneratedFile),
  cfg: config.Config,
  on_write: fn(String) -> Nil,
) -> Result(List(String), WriteError)

Write pre-generated files to disk based on configuration.

✨ Search Document