fs2.data.pattern.IsPattern.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fs2-data-finite-state_2.13 Show documentation

Streaming finite state machines

The newest version!

/*
 * Copyright 2024 fs2-data Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package fs2.data.pattern

/** A type class that describes how the pattern type `Pat`
  * can be decomposed into [[Skeleton]]s.
  *
  * Skeletons represent `or` patterns, and are matched left to right.
  */
trait IsPattern[Pat, Expr, Tag] {

  def decompose(pat: Pat): List[RawSkeleton[Expr, Tag]]

  def trueTag: Tag

}