Module: Anydoc::Native Private

Defined in:
sig/anydoc.rbs

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Argument coercion and file reading happen in Ruby; these are the raw entry points the extension defines.

Class Method Summary collapse

Class Method Details

.format_from_bytesSymbol?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • data (String)

Returns:

  • (Symbol, nil)


26
# File 'sig/anydoc.rbs', line 26

def self.format_from_bytes: (String data) -> Symbol?

.format_from_extensionSymbol?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • extension (String)

Returns:

  • (Symbol, nil)


27
# File 'sig/anydoc.rbs', line 27

def self.format_from_extension: (String extension) -> Symbol?

.to_documentDocument

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • data (String)
  • format (Symbol, nil)

Returns:



25
# File 'sig/anydoc.rbs', line 25

def self.to_document: (String data, Symbol? format) -> Document

.to_markdown_bytesString

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • data (String)
  • format (Symbol, nil)

Returns:

  • (String)


24
# File 'sig/anydoc.rbs', line 24

def self.to_markdown_bytes: (String data, Symbol? format) -> String