在 Scala 文档中搜索 #::

Question

我正在尝试查找 Scala 运算符方法 #:: 的文档。我相信它是在 Stream 类中定义的，因为 示例 我发现使用它。

我的问题并不是特定于此方法（尽管我想知道文档在哪里），而是如何搜索一般的 Scala 文档。我尝试在文档页面（2.8.1）左上角的搜索框中输入 #::，但什么也没找到。

Answer 1

我建议使用 参考索引 - 它专门设计用于查找任何类型的符号（类、特征、方法、值、变量），无论其层次位置如何 - 与 Scaladoc 的左侧索引形成对比，后者不显示内部类、特征或物体。

不幸的是，它只在夜间提供。您可以在 nightly 查看整个内容斯卡拉多克。请注意左框架中索引上方的上部框。

希望它能与 Scala 2.9.0 捆绑在一起。

编辑 从 2.9.0 开始，参考索引开始与 Scaladoc。现在无需查看夜间文档。

Answer 2

正如其他人已经提到的，#:: 是在 scala.collection.immutable.Stream.ConsWrapper。我只是想花一点时间来详细说明原因。

一般来说，要调用对象上的运算符，该对象需要存在。然而，流的想法是直到需要时才评估流的尾部。因此，请考虑以下流：

def fibs(a:Int,b:Int):Stream[Int] = a #:: fibs(b,a+b)

通常，我们需要评估递归 fibs 调用，以便我们可以对其调用 #:: 运算符。这会导致递归失控。这不是我们想要的。我们想要的是接收者是一个名为Stream的接收者。因此，ConsWrapper：

ConsWrapper 的构造函数是 class ConsWrapper[T](tail: => Stream[T])，采用 by-名称 Stream，它是通过隐式转换 Stream.consWrapper[T](stream: => Stream[T]) 创建的，该转换还采用名称 <代码>流。

因此，我们对尚未调用的函数的结果执行了隐式转换，并且模仿了使用名称 this#:: 的效果代码>参考。

Answer 3

这里的问题是 scaladoc 搜索不允许您查找内部类/对象（即其父类不是包）。 #:: 的声明是 Stream.#:: 或 Stream.ConsWrapper.#::：

object Stream { 
  //STUFF
  /** An extractor that allows to pattern match streams with `#::`.
   */
  object #:: {
    def unapply[A](xs: Stream[A]): Option[(A, Stream[A])] = 
      if (xs.isEmpty) None
      else Some((xs.head, xs.tail))
  }
  class ConsWrapper[A](tl: => Stream[A]) {
    def #::(hd: A): Stream[A] = new Stream.Cons(hd, tl)
    def #:::(prefix: Stream[A]): Stream[A] = prefix append tl
  }
  //MORE STUFF
}

您可以将其作为 RFE 请求到 trac 中的 scaladoc 工具。

在 IntelliJ IDEA 的 scala 插件中，您可以使用符号查找 (CTRL+ ALT+ SHIFT+ N）并输入 #:: ，这将立即显示 #:: 的两个声明。

Answer 4

该特定方法在 Stream 内部的嵌套类中定义，称为 scala.collection.immutable.Stream.ConsWrapper。

不，我完全不知道如何找到它。我只是偶然发现的。尽管我现在知道在哪里可以找到它，但当我想在答案中发布该课程的链接时，我仍然第一次找不到它（甚至第二次和第三次）尝试。

Answer 5

好吧，通常情况下，如果我们看到

foo bar baz 

bar 是一个为 foo 定义的方法，那么我们首先查看类/对象 - foo 的定义，然后向上查看继承/特征树（+ 在与 foo 的隐式转换中，在当前文件，以及（直接）包含的文件中）。

除了“bar”以冒号结尾之外，这里就是这种情况。那么就要以相反的顺序读取——

foo bar: baz 

不是

foo.bar: (baz)

，而是

baz.bar: (foo) 

所以我们必须按照上面描述的方式查找，但不是查找 foo，而是查找 baz。