File: ansi_string.Rd

package info (click to toggle)
r-cran-cli 3.6.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,288 kB
  • sloc: ansic: 16,412; cpp: 37; sh: 13; makefile: 2
file content (29 lines) | stat: -rw-r--r-- 750 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_string}
\alias{ansi_string}
\title{Labels a character vector as containing ANSI control codes.}
\usage{
ansi_string(x)
}
\arguments{
\item{x}{A character vector or something that can be
coerced into one.}
}
\value{
A \code{cli_ansi_string} object, a subclass of
\code{character}, with the same length and contents
as \code{x}.
}
\description{
This function sets the class of its argument, activating
ANSI-string-specific methods such as for printing.
}
\seealso{
Other low level ANSI functions: 
\code{\link{ansi_has_any}()},
\code{\link{ansi_hide_cursor}()},
\code{\link{ansi_regex}()},
\code{\link{ansi_strip}()}
}
\concept{low level ANSI functions}