Introspection · Term.jl

# Introspection

- `Term.introspection.TypeInfo`
- `Term.introspection.TypeInfo`
- `Term.introspection.TypeInfo`
- `Term.introspection.get_docstring`
- `Term.introspection.inspect`
- `Term.introspection.inspect`
- `Term.introspection.inspect`
- `Term.introspection.style_method_line`
- `Term.introspection.style_sub_types`
- `Term.introspection.style_super_types`

`Term.introspection.TypeInfo` — Type

    TypeInfo

Stores metadata about a DataType

source
`Term.introspection.TypeInfo` — Method

    TypeInfo(type::DataType)

Extract information from a DataType and store it as a `TypeInfo` object.

source
`Term.introspection.TypeInfo` — Method

    TypeInfo(fun::Function)

Exctract information from a function object

source
`Term.introspection.get_docstring` — Method

    get_docstring(obj)

Extract and style an object's docstring.

source
`Term.introspection.inspect` — Method

generic inspect method, dispatches to type-specific methods when they can be found

source
`Term.introspection.inspect` — Method

    inspect(type::DataType; width::Int=120)

Introspect a type.

Extract info like docstring, fields, types etc. and show it in a structured terminal output.

source
`Term.introspection.inspect` — Method

    inspect(fun::Function; width::Int=88, max_n_methods::Int = 7)

Inspects `Function` objects providing docstrings, and methods signatures.

source
`Term.introspection.style_method_line` — Method

    style_method_line(method::AbstractString; trim::Bool=false)::String

Style a string with method info (name, args, path...)

source
`Term.introspection.style_sub_types` — Method

    style_sub_types(info)::String

Style a vector of sub types.

source
`Term.introspection.style_super_types` — Method

    style_super_types(info)::String

Style a vector of super types

source

Theme

This document was generated with Documenter.jl version 0.27.14 on Wednesday 9 March 2022. Using Julia version 1.6.5.