r/man/Field-class.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/field.R
\docType{class}
\name{Field}
\alias{Field}
\title{Field class}
\description{
\code{field()} lets you create an \code{arrow::Field} that maps a
\link[=data-type]{DataType} to a column name. Fields are contained in
\link[=Schema]{Schemas}.
}
\section{Methods}{

\itemize{
\item \code{f$ToString()}: convert to a string
\item \code{f$Equals(other, check_metadata = FALSE)}: test for equality.
More naturally called as \code{f == other}
\item \code{f$WithMetadata(metadata)}: returns a new \code{Field} with the key-value
\code{metadata} set. Note that all list elements in \code{metadata} will be coerced
to \code{character}.
\item \code{f$RemoveMetadata()}: returns a new \code{Field} without metadata.
}
}

\section{Active bindings}{

\itemize{
\item \verb{$HasMetadata}: logical: does this \code{Field} have extra metadata?
\item \verb{$metadata}: returns the key-value metadata as a named list, or \code{NULL}
if no metadata is set.
}
}