Local: Local

LocalR Documentation

Local

Description

Local Class

Methods

Public methods


Method new()

Usage
Local$new(local, config = list(), host = NULL)

Method set_local()

Usage
Local$set_local(raw)

Method parse()

Usage
Local$parse(raw)

Method parse_comment()

Usage
Local$parse_comment(raw)

Method parse_tag()

Usage
Local$parse_tag(raw)

Method is_ascii()

Usage
Local$is_ascii()

Method is_unicode()

Usage
Local$is_unicode()

Method is_redacted()

Usage
Local$is_redacted()

Method format()

Usage
Local$format(form = self$config$config[["local_format"]] %||% "conventional")

Method to_s()

Usage
Local$to_s()

Method conventional()

Usage
Local$conventional()

Method canonical()

Usage
Local$canonical()

Method relax()

Usage
Local$relax()

Method standard()

Usage
Local$standard()

Method munge()

Usage
Local$munge()

Method valid()

Usage
Local$valid(
  format = self$config$config[["local_format"]] %||% "conventional"
)

Method valid_size()

Usage
Local$valid_size()

Method valid_size_checks()

Usage
Local$valid_size_checks(range)

Method valid_encoding()

Usage
Local$valid_encoding(
  enc = self$config$config[["local_encoding"]] %||% "ascii"
)

Method is_conventional()

Usage
Local$is_conventional()

Method is_relaxed()

Usage
Local$is_relaxed()

Method is_standard()

Usage
Local$is_standard()

Method clone()

The objects of this class are cloneable with this method.

Usage
Local$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
host <- Host$new("gmail.com")
x <- Local$new("very.common", list(), host)
x
x$valid()
x$local
x$format()
x$munge()
x$error
x$error_message
x$config$config

## End(Not run)

ropenscilabs/addressable documentation built on Sept. 13, 2022, 11:32 p.m.