stacky - v1.1.0

stacky

Types

ErlangFileName

</> 
pub type ErlangFileName {
  ErlangFileName(String)
}

Constructors 

  • ErlangFileName(String)

ErlangLineNumber

</> 
pub type ErlangLineNumber {
  ErlangLineNumber(Int)
}

Constructors 

  • ErlangLineNumber(Int)

ErlangModuleName

</> 
pub type ErlangModuleName {
  ErlangModuleName(String)
}

Constructors 

  • ErlangModuleName(String)

FunctionArity

</> 
pub type FunctionArity {
  FunctionArity(Int)
}

Constructors 

  • FunctionArity(Int)

FunctionName

</> 
pub type FunctionName {
  FunctionName(String)
}

Constructors 

  • FunctionName(String)

StackFrame

</> 
pub type StackFrame {
  StackFrame(
    index: StackIndex,
    erlang_module_name: ErlangModuleName,
    function_name: FunctionName,
    function_arity: FunctionArity,
    erlang_file_name: ErlangFileName,
    erlang_line_number: ErlangLineNumber,
  )
}

Constructors 

  • StackFrame(
  index: StackIndex,
  erlang_module_name: ErlangModuleName,
  function_name: FunctionName,
  function_arity: FunctionArity,
  erlang_file_name: ErlangFileName,
  erlang_line_number: ErlangLineNumber,
)

StackIndex

</> 
pub type StackIndex {
  StackIndex(Int)
}

Constructors 

  • StackIndex(Int)

StackTrace

</> 
pub type StackTrace {
  StackTrace(List(StackFrame))
}

Constructors 

  • StackTrace(List(StackFrame))

Functions

erlang_file_name

</> 
pub fn erlang_file_name(stack_frame: StackFrame) -> String

Gets the erlang file name of the stack frame.

erlang_line_number

</> 
pub fn erlang_line_number(stack_frame: StackFrame) -> Int

Gets the ang erlline number of the stack frame.

erlang_module_name

</> 
pub fn erlang_module_name(stack_frame: StackFrame) -> String

Gets the erlang module name of the stack frame.

frame

</> 
pub fn frame(stacktrace: StackTrace, index: Int) -> StackFrame

Gets the stack frame at the given list index.

Latest stack frame is at index 0. The StackFrame itself has an inverse index field that represents the index of the frame within the stack.

frame_to_string

</> 
pub fn frame_to_string(stack_frame: StackFrame) -> String

Converts a stack frame to a string.

function_arity

</> 
pub fn function_arity(stack_frame: StackFrame) -> Int

Gets the function arity of the stack frame.

function_name

</> 
pub fn function_name(stack_frame: StackFrame) -> String

Gets the function name of the stack frame.

gleam_module_name

</> 
pub fn gleam_module_name(stack_frame: StackFrame) -> String

Gets the potential gleam module name from the erlang source file name from the stack frame.

main

</> 
pub fn main() -> Nil

This is a library and the main function exists as a placeholder if called as a function from the command line.

</> 
pub fn print_frame(stack_frame: StackFrame) -> Nil

Print a stack frame.

</> 
pub fn print_frame_with(
  stack_frame: StackFrame,
  context c: a,
) -> Nil

Print a stack frame with context.

</> 
pub fn print_trace(stack_trace: StackTrace) -> Nil

Print a stack trace.

</> 
pub fn print_trace_with(
  stack_trace: StackTrace,
  context c: a,
) -> Nil

Print a stack trace with context.

stack_index

</> 
pub fn stack_index(stack_frame: StackFrame) -> Int

Gets the stack index within its parent stack frame.

trace

</> 
pub fn trace() -> StackTrace

Gets the stack trace of the current process.

trace_to_string

</> 
pub fn trace_to_string(stack_frame: StackTrace) -> String

Converts a stack trace to a string.

✨ Search Document