% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/60-interval_index-query-api.R
\name{pop_overlaps}
\alias{pop_overlaps}
\title{Pop First Overlapping Interval}
\usage{
pop_overlaps(x, start, end, bounds = NULL)
}
\arguments{
\item{x}{An \code{interval_index}.}

\item{start}{Query interval start.}

\item{end}{Query interval end.}

\item{bounds}{Optional boundary override. One of \code{"[)"}, \code{"[]"}, \code{"()"}, \code{"(]"}.}
}
\value{
A list with \code{element}, \code{start}, \code{end}, and \code{remaining}.
On miss: \code{element}, \code{start}, and \code{end} are \code{NULL}.
}
\description{
Pop First Overlapping Interval
}
\details{
Removes the first match in canonical interval order. On miss, returns a
non-throwing miss object with \code{remaining = x}.
Use \code{\link[=pop_all_overlaps]{pop_all_overlaps()}} to remove all matches.
}
\examples{
ix <- interval_index("a", "b", "c", start = c(1, 3, 5), end = c(2, 4, 6))
pop_overlaps(ix, 2, 3)
}
