PageRenderTime 37ms CodeModel.GetById 24ms RepoModel.GetById 1ms app.codeStats 1ms

/dotnet/Hybrid.Automation.Framework/packages/FluentAssertions.2.0.0.1/lib/net35/FluentAssertions.xml

https://github.com/beeaux/automation-frameworks
XML | 5761 lines | 5761 code | 0 blank | 0 comment | 0 complexity | b485bfc26da14564fc32d884e9cf0c19 MD5 | raw file

Large files files are truncated, but you can click here to view the full file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>FluentAssertions</name>
  5. </assembly>
  6. <members>
  7. <member name="M:FluentAssertions.Common.StringExtensions.IndexOfFirstMismatch(System.String,System.String)">
  8. <summary>
  9. Finds the first index at which the <paramref name="value"/> does not match the <paramref name="expected"/>
  10. string anymore, including the exact casing.
  11. </summary>
  12. </member>
  13. <member name="M:FluentAssertions.Common.StringExtensions.IndexOfFirstMismatch(System.String,System.String,System.StringComparison)">
  14. <summary>
  15. Finds the first index at which the <paramref name="value"/> does not match the <paramref name="expected"/>
  16. string anymore, accounting for the specified <paramref name="stringComparison"/>.
  17. </summary>
  18. </member>
  19. <member name="M:FluentAssertions.Common.StringExtensions.IndexedSegmentAt(System.String,System.Int32)">
  20. <summary>
  21. Gets the quoted three characters at the specified index of a string, including the index itself.
  22. </summary>
  23. </member>
  24. <member name="M:FluentAssertions.Common.StringExtensions.Escape(System.String)">
  25. <summary>
  26. Replaces all characters that might conflict with formatting placeholders and newlines with their escaped counterparts.
  27. </summary>
  28. </member>
  29. <member name="M:FluentAssertions.Common.StringExtensions.Combine(System.String,System.String,System.String)">
  30. <summary>
  31. Joins a string with one or more other strings using a specified separator.
  32. </summary>
  33. <remarks>
  34. Any string that is empty (including the original string) is ignored.
  35. </remarks>
  36. </member>
  37. <member name="M:FluentAssertions.Common.TypeExtensions.IsEquivalentTo(System.Reflection.PropertyInfo,System.Reflection.PropertyInfo)">
  38. <summary>
  39. Determines whether two <see cref="T:System.Reflection.PropertyInfo"/> objects refer to the same property.
  40. </summary>
  41. </member>
  42. <member name="M:FluentAssertions.Common.TypeExtensions.FindProperty(System.Type,System.String)">
  43. <summary>
  44. Finds the property by a case-sensitive name.
  45. </summary>
  46. <returns>
  47. Returns <c>null</c> if no such property exists.
  48. </returns>
  49. </member>
  50. <member name="M:FluentAssertions.Common.TypeExtensions.HasAttribute``1(System.Reflection.MethodInfo)">
  51. <summary>
  52. Determines whether the specified method has been annotated with a specific attribute.
  53. </summary>
  54. <returns>
  55. <c>true</c> if the specified method has attribute; otherwise, <c>false</c>.
  56. </returns>
  57. </member>
  58. <member name="T:FluentAssertions.Formatting.AttributeBasedFormatter">
  59. <summary>
  60. Specialized value formatter that looks for static methods in the caller's assembly marked with the
  61. <see cref="T:FluentAssertions.Formatting.ValueFormatterAttribute"/>.
  62. </summary>
  63. </member>
  64. <member name="M:FluentAssertions.Formatting.IValueFormatter.CanHandle(System.Object)">
  65. <summary>
  66. Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
  67. </summary>
  68. <param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
  69. <returns>
  70. <c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
  71. </returns>
  72. </member>
  73. <member name="M:FluentAssertions.Formatting.IValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
  74. <summary>
  75. Returns a <see cref="T:System.String"/> that represents this instance.
  76. </summary>
  77. <param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
  78. <param name="useLineBreaks"> </param>
  79. <param name="processedObjects">
  80. A collection of objects that
  81. </param>
  82. <param name="nestedPropertyLevel">
  83. The level of nesting for the supplied value. This is used for indenting the format string for objects that have
  84. no <see cref="M:System.Object.ToString"/> override.
  85. </param>
  86. <returns>
  87. A <see cref="T:System.String"/> that represents this instance.
  88. </returns>
  89. </member>
  90. <member name="M:FluentAssertions.Formatting.AttributeBasedFormatter.CanHandle(System.Object)">
  91. <summary>
  92. Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
  93. </summary>
  94. <param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
  95. <returns>
  96. <c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
  97. </returns>
  98. </member>
  99. <member name="M:FluentAssertions.Formatting.AttributeBasedFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
  100. <summary>
  101. Returns a <see cref="T:System.String"/> that represents this instance.
  102. </summary>
  103. <param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
  104. <param name="useLineBreaks"> </param>
  105. <param name="processedObjects">
  106. A collection of objects that
  107. </param>
  108. <param name="nestedPropertyLevel">
  109. The level of nesting for the supplied value. This is used for indenting the format string for objects that have
  110. no <see cref="M:System.Object.ToString"/> override.
  111. </param>
  112. <returns>
  113. A <see cref="T:System.String"/> that represents this instance.
  114. </returns>
  115. </member>
  116. <member name="M:FluentAssertions.Formatting.GuidValueFormatter.CanHandle(System.Object)">
  117. <summary>
  118. Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
  119. </summary>
  120. <param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
  121. <returns>
  122. <c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
  123. </returns>
  124. </member>
  125. <member name="M:FluentAssertions.Formatting.GuidValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
  126. <summary>
  127. Returns a <see cref="T:System.String"/> that represents this instance.
  128. </summary>
  129. <param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
  130. <param name="useLineBreaks"> </param>
  131. <param name="processedObjects">
  132. A collection of objects that
  133. </param>
  134. <param name="nestedPropertyLevel">
  135. The level of nesting for the supplied value. This is used for indenting the format string for objects that have
  136. no <see cref="M:System.Object.ToString"/> override.
  137. </param>
  138. <returns>
  139. A <see cref="T:System.String"/> that represents this instance.
  140. </returns>
  141. </member>
  142. <member name="T:FluentAssertions.Formatting.ValueFormatterAttribute">
  143. <summary>
  144. Marks a static method as a kind of <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> for a particular type.
  145. </summary>
  146. </member>
  147. <member name="T:FluentAssertions.Specialized.ActionAssertions">
  148. <summary>
  149. Contains a number of methods to assert that an <see cref="T:System.Action"/> yields the expected result.
  150. </summary>
  151. </member>
  152. <member name="M:FluentAssertions.Specialized.ActionAssertions.ShouldThrow``1(System.String,System.Object[])">
  153. <summary>
  154. Asserts that the current <see cref="T:System.Action"/> throws an exception of type <typeparamref name="TException"/>.
  155. </summary>
  156. <param name="reason">
  157. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  158. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  159. </param>
  160. <param name="reasonArgs">
  161. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  162. </param>
  163. </member>
  164. <member name="M:FluentAssertions.Specialized.ActionAssertions.ShouldNotThrow``1(System.String,System.Object[])">
  165. <summary>
  166. Asserts that the current <see cref="T:System.Action"/> does not throw an exception of type <typeparamref name="TException"/>.
  167. </summary>
  168. <param name="reason">
  169. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  170. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  171. </param>
  172. <param name="reasonArgs">
  173. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  174. </param>
  175. </member>
  176. <member name="M:FluentAssertions.Specialized.ActionAssertions.ShouldNotThrow(System.String,System.Object[])">
  177. <summary>
  178. Asserts that the current <see cref="T:System.Action"/> does not throw any exception.
  179. </summary>
  180. <param name="reason">
  181. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  182. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  183. </param>
  184. <param name="reasonArgs">
  185. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  186. </param>
  187. </member>
  188. <member name="P:FluentAssertions.Specialized.ActionAssertions.Subject">
  189. <summary>
  190. Gets the <see cref="T:System.Action"/> that is being asserted.
  191. </summary>
  192. </member>
  193. <member name="M:FluentAssertions.AndConstraint`1.#ctor(`0)">
  194. <summary>
  195. Initializes a new instance of the <see cref="T:System.Object"/> class.
  196. </summary>
  197. </member>
  198. <member name="T:FluentAssertions.Equivalency.AllDeclaredPublicPropertiesSelectionRule">
  199. <summary>
  200. Selection rule that adds all public properties of the subject as far as they are defined on the declared
  201. type.
  202. </summary>
  203. </member>
  204. <member name="T:FluentAssertions.Equivalency.ISelectionRule">
  205. <summary>
  206. Represents a rule that defines which properties of the subject-under-test to include while comparing
  207. two objects for structural equality.
  208. </summary>
  209. </member>
  210. <member name="M:FluentAssertions.Equivalency.ISelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
  211. <summary>
  212. Adds or removes properties to/from the collection of subject properties that must be included while
  213. comparing two objects for structural equality.
  214. </summary>
  215. <param name="properties">
  216. A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
  217. <param name="info">
  218. Type info about the subject.
  219. </param>
  220. <returns>
  221. The collection of properties after applying this rule. Can contain less or more than was passed in.
  222. </returns>
  223. </member>
  224. <member name="M:FluentAssertions.Equivalency.AllDeclaredPublicPropertiesSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
  225. <summary>
  226. Adds or removes properties to/from the collection of subject properties that must be included while
  227. comparing two objects for structural equality.
  228. </summary>
  229. <param name="properties">
  230. A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
  231. <returns>
  232. The collection of properties after applying this rule. Can contain less or more than was passed in.
  233. </returns>
  234. </member>
  235. <member name="M:FluentAssertions.Equivalency.AllDeclaredPublicPropertiesSelectionRule.ToString">
  236. <summary>
  237. Returns a string that represents the current object.
  238. </summary>
  239. <returns>
  240. A string that represents the current object.
  241. </returns>
  242. <filterpriority>2</filterpriority>
  243. </member>
  244. <member name="T:FluentAssertions.Equivalency.AllRuntimePublicPropertiesSelectionRule">
  245. <summary>
  246. Selection rule that adds all public properties of the subject based on its run-time type rather than its
  247. declared type.
  248. </summary>
  249. </member>
  250. <member name="M:FluentAssertions.Equivalency.AllRuntimePublicPropertiesSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
  251. <summary>
  252. Adds or removes properties to/from the collection of subject properties that must be included while
  253. comparing two objects for structural equality.
  254. </summary>
  255. <param name="properties">
  256. A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
  257. <returns>
  258. The collection of properties after applying this rule. Can contain less or more than was passed in.
  259. </returns>
  260. </member>
  261. <member name="M:FluentAssertions.Equivalency.AllRuntimePublicPropertiesSelectionRule.ToString">
  262. <summary>
  263. Returns a string that represents the current object.
  264. </summary>
  265. <returns>
  266. A string that represents the current object.
  267. </returns>
  268. <filterpriority>2</filterpriority>
  269. </member>
  270. <member name="M:FluentAssertions.Equivalency.IEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext)">
  271. <summary>
  272. Gets a value indicating whether this step can handle the current subject and/or expectation.
  273. </summary>
  274. </member>
  275. <member name="M:FluentAssertions.Equivalency.IEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator)">
  276. <summary>
  277. Applies a step as part of the task to compare two objects for structural equality.
  278. </summary>
  279. <value>
  280. Should return <c>true</c> if the subject matches the expectation or if no additional assertions
  281. have to be executed. Should return <c>false</c> otherwise.
  282. </value>
  283. <remarks>
  284. May throw when preconditions are not met or if it detects mismatching data.
  285. </remarks>
  286. </member>
  287. <member name="M:FluentAssertions.Equivalency.ApplyAssertionRulesEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext)">
  288. <summary>
  289. Gets a value indicating whether this step can handle the current subject and/or expectation.
  290. </summary>
  291. </member>
  292. <member name="M:FluentAssertions.Equivalency.ApplyAssertionRulesEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator)">
  293. <summary>
  294. Applies a step as part of the task to compare two objects for structural equality.
  295. </summary>
  296. <value>
  297. Should return <c>true</c> if the subject matches the expectation or if no additional assertions
  298. have to be executed. Should return <c>false</c> otherwise.
  299. </value>
  300. <remarks>
  301. May throw when preconditions are not met or if it detects mismatching data.
  302. </remarks>
  303. </member>
  304. <member name="T:FluentAssertions.Equivalency.AssertionRule`1">
  305. <summary>
  306. General purpose implementation of <see cref="T:FluentAssertions.Equivalency.IAssertionRule"/> that uses a predicate to determine whether
  307. this rule applies to a particular property and executes an action to assert equality.
  308. </summary>
  309. <typeparam name="TSubject">The type of the subject.</typeparam>
  310. </member>
  311. <member name="M:FluentAssertions.Equivalency.IAssertionRule.AssertEquality(FluentAssertions.Equivalency.IEquivalencyValidationContext)">
  312. <summary>
  313. Defines how a subject's property is compared for equality with the same property of the expectation.
  314. </summary>
  315. <param name="subjectProperty">
  316. Provides details about the subject's property.
  317. </param>
  318. <param name="subject">
  319. The value of the subject's property.
  320. </param>
  321. <param name="expectation">
  322. The value of a property on expectation object that was identified
  323. </param>
  324. <returns>
  325. Returns <c>true</c> if the rule was applied correctly and the assertion didn't cause any exceptions.
  326. Returns <c>false</c> if this rule doesn't support the subject's type.
  327. Throws if the rule did support the data type but assertion fails.
  328. </returns>
  329. </member>
  330. <member name="M:FluentAssertions.Equivalency.AssertionRule`1.AssertEquality(FluentAssertions.Equivalency.IEquivalencyValidationContext)">
  331. <summary>
  332. Defines how a subject's property is compared for equality with the same property of the expectation.
  333. </summary>
  334. <param name="subjectProperty">
  335. Provides details about the subject's property.
  336. </param>
  337. <param name="subject">
  338. The value of the subject's property.
  339. </param>
  340. <param name="expectation">
  341. The value of a property on expectation object that was identified
  342. </param>
  343. <returns>
  344. Returns <c>true</c> if the rule was applied correctly and the assertion didn't cause any exceptions.
  345. Returns <c>false</c> if this rule doesn't support the subject's type.
  346. Throws if the rule did support the data type but assertion fails.
  347. </returns>
  348. </member>
  349. <member name="T:FluentAssertions.Equivalency.IAssertionContext`1">
  350. <summary>
  351. Provides the required information for executing an equality assertion between a subject and an expectation.
  352. </summary>
  353. <typeparam name="TSubject">The type of the subject.</typeparam>
  354. </member>
  355. <member name="P:FluentAssertions.Equivalency.IAssertionContext`1.SubjectProperty">
  356. <summary>
  357. Gets the <see cref="T:System.Reflection.PropertyInfo"/> of the property that returned the current object, or <c>null</c> if the current
  358. object represents the root object.
  359. </summary>
  360. </member>
  361. <member name="P:FluentAssertions.Equivalency.IAssertionContext`1.Subject">
  362. <summary>
  363. Gets the value of the <see cref="P:FluentAssertions.Equivalency.IAssertionContext`1.SubjectProperty"/>
  364. </summary>
  365. </member>
  366. <member name="P:FluentAssertions.Equivalency.IAssertionContext`1.Expectation">
  367. <summary>
  368. Gets the value of the expectation object that was matched with the subject using a <see cref="T:FluentAssertions.Equivalency.IMatchingRule"/>.
  369. </summary>
  370. </member>
  371. <member name="P:FluentAssertions.Equivalency.IAssertionContext`1.Reason">
  372. <summary>
  373. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  374. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  375. </summary>
  376. </member>
  377. <member name="P:FluentAssertions.Equivalency.IAssertionContext`1.ReasonArgs">
  378. <summary>
  379. Zero or more objects to format using the placeholders in <see cref="P:FluentAssertions.Equivalency.IAssertionContext`1.Reason"/>.
  380. </summary>
  381. </member>
  382. <member name="T:FluentAssertions.Equivalency.ExcludePropertyByPredicateSelectionRule">
  383. <summary>
  384. Selection rule that removes a particular property from the structural comparison based on a predicate.
  385. </summary>
  386. </member>
  387. <member name="M:FluentAssertions.Equivalency.ExcludePropertyByPredicateSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
  388. <summary>
  389. Adds or removes properties to/from the collection of subject properties that must be included while
  390. comparing two objects for structural equality.
  391. </summary>
  392. <param name="properties">
  393. A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
  394. <returns>
  395. The collection of properties after applying this rule. Can contain less or more than was passed in.
  396. </returns>
  397. </member>
  398. <member name="M:FluentAssertions.Equivalency.ExcludePropertyByPredicateSelectionRule.ToString">
  399. <summary>
  400. Returns a string that represents the current object.
  401. </summary>
  402. <returns>
  403. A string that represents the current object.
  404. </returns>
  405. <filterpriority>2</filterpriority>
  406. </member>
  407. <member name="T:FluentAssertions.Equivalency.ISubjectInfo">
  408. <summary>
  409. Provides details about the subject's root or nested property.
  410. </summary>
  411. </member>
  412. <member name="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo">
  413. <summary>
  414. Gets the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo"/> of the property that returned the current object, or <c>null</c> if the current
  415. object represents the root object.
  416. </summary>
  417. </member>
  418. <member name="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyPath">
  419. <summary>
  420. Gets the full path from the root object until the current object separated by dots.
  421. </summary>
  422. </member>
  423. <member name="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyDescription">
  424. <summary>
  425. Gets a display-friendly representation of the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyPath"/>.
  426. </summary>
  427. </member>
  428. <member name="P:FluentAssertions.Equivalency.ISubjectInfo.CompileTimeType">
  429. <summary>
  430. Gets the compile-time type of the current object. If the current object is not the root object, then it returns the
  431. same <see cref="T:System.Type"/> as the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.RuntimeType"/> property does.
  432. </summary>
  433. </member>
  434. <member name="P:FluentAssertions.Equivalency.ISubjectInfo.RuntimeType">
  435. <summary>
  436. Gets the run-time type of the current object.
  437. </summary>
  438. </member>
  439. <member name="T:FluentAssertions.Equivalency.IEquivalencyAssertionOptions">
  440. <summary>
  441. Provides the run-time details of the <see cref="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1"/> class.
  442. </summary>
  443. </member>
  444. <member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.SelectionRules">
  445. <summary>
  446. Gets an ordered collection of selection rules that define what properties are included.
  447. </summary>
  448. </member>
  449. <member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.MatchingRules">
  450. <summary>
  451. Gets an ordered collection of matching rules that determine which subject properties are matched with which
  452. expectation properties.
  453. </summary>
  454. </member>
  455. <member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.AssertionRules">
  456. <summary>
  457. Gets an ordered collection of assertion rules that determine how subject properties are compared for equality with
  458. expectation properties.
  459. </summary>
  460. </member>
  461. <member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.IsRecursive">
  462. <summary>
  463. Gets or sets a value indicating whether or not the assertion must perform a deep comparison.
  464. </summary>
  465. </member>
  466. <member name="T:FluentAssertions.Equivalency.NestedSelectionContext">
  467. <summary>
  468. Represents a selection context of a nested property
  469. </summary>
  470. </member>
  471. <member name="P:FluentAssertions.Equivalency.NestedSelectionContext.PropertyInfo">
  472. <summary>
  473. Gets the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo"/> of the property that returned the current object, or
  474. <c>null</c> if the current object represents the root object.
  475. </summary>
  476. </member>
  477. <member name="P:FluentAssertions.Equivalency.NestedSelectionContext.PropertyPath">
  478. <summary>
  479. Gets the full path from the root object until the current property, separated by dots.
  480. </summary>
  481. </member>
  482. <member name="P:FluentAssertions.Equivalency.NestedSelectionContext.PropertyDescription">
  483. <summary>
  484. Gets a textual description of the current property based on the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyPath"/>.
  485. </summary>
  486. </member>
  487. <member name="P:FluentAssertions.Equivalency.NestedSelectionContext.CompileTimeType">
  488. <summary>
  489. Gets the compile-time type of the current object. If the current object is not the root object, then it returns the
  490. same <see cref="T:System.Type"/> as the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.RuntimeType"/> property does.
  491. </summary>
  492. </member>
  493. <member name="P:FluentAssertions.Equivalency.NestedSelectionContext.RuntimeType">
  494. <summary>
  495. Gets the run-time type of the current object.
  496. </summary>
  497. </member>
  498. <member name="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1">
  499. <summary>
  500. Is responsible for the exact run-time behavior of a structural equality comparison.
  501. </summary>
  502. <typeparam name="TSubject">The type of the subject.</typeparam>
  503. </member>
  504. <member name="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Default">
  505. <summary>
  506. Gets a configuration that compares all declared properties of the subject with equally named properties of the expectation,
  507. and includes the entire object graph. The names of the properties between the subject and expectation must match.
  508. </summary>
  509. </member>
  510. <member name="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Empty">
  511. <summary>
  512. Gets a configuration that by default doesn't include any of the subject's properties and doesn't consider any nested objects
  513. or collections.
  514. </summary>
  515. </member>
  516. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IncludingAllDeclaredProperties">
  517. <summary>
  518. Adds all public properties of the subject as far as they are defined on the declared type.
  519. </summary>
  520. </member>
  521. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IncludingAllRuntimeProperties">
  522. <summary>
  523. Adds all public properties of the subject based on its run-time type rather than its declared type.
  524. </summary>
  525. </member>
  526. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.ExcludingMissingProperties">
  527. <summary>
  528. Tries to match the properties of the subject with equally named properties on the expectation. Ignores those
  529. properties that don't exist on the expectation.
  530. </summary>
  531. </member>
  532. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.ThrowingOnMissingProperties">
  533. <summary>
  534. Requires the expectation to have properties which are equally named to properties on the subject.
  535. </summary>
  536. <returns></returns>
  537. </member>
  538. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Excluding(System.Linq.Expressions.Expression{System.Func{`0,System.Object}})">
  539. <summary>
  540. Excludes the specified (nested) property from the structural equality check.
  541. </summary>
  542. </member>
  543. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Excluding(System.Linq.Expressions.Expression{System.Func{FluentAssertions.Equivalency.ISubjectInfo,System.Boolean}})">
  544. <summary>
  545. Excludes a (nested) property based on a predicate from the structural equality check.
  546. </summary>
  547. </member>
  548. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Including(System.Linq.Expressions.Expression{System.Func{`0,System.Object}})">
  549. <summary>
  550. Includes the specified property in the equality check.
  551. </summary>
  552. <remarks>
  553. This overrides the default behavior of including all declared properties.
  554. </remarks>
  555. </member>
  556. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using``1(System.Action{FluentAssertions.Equivalency.IAssertionContext{``0}})">
  557. <param name="action">
  558. The assertion to execute when the predicate is met.
  559. </param>
  560. </member>
  561. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IncludingNestedObjects">
  562. <summary>
  563. Causes the structural equality check to include nested collections and complex types.
  564. </summary>
  565. </member>
  566. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IgnoringCyclicReferences">
  567. <summary>
  568. Causes the structural equality check to ignore any cyclic references.
  569. </summary>
  570. <remarks>
  571. By default, cyclic references within the object graph will cause an exception to be thrown.
  572. </remarks>
  573. </member>
  574. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.WithoutSelectionRules">
  575. <summary>
  576. Clears all selection rules, including those that were added by default.
  577. </summary>
  578. </member>
  579. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.WithoutMatchingRules">
  580. <summary>
  581. Clears all matching rules, including those that were added by default.
  582. </summary>
  583. </member>
  584. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using(FluentAssertions.Equivalency.ISelectionRule)">
  585. <summary>
  586. Adds a selection rule to the ones allready added by default and which is evaluated after all existing rules.
  587. </summary>
  588. </member>
  589. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using(FluentAssertions.Equivalency.IMatchingRule)">
  590. <summary>
  591. Adds a matching rule to the ones allready added by default and which is evaluated before all existing rules.
  592. </summary>
  593. </member>
  594. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using(FluentAssertions.Equivalency.IAssertionRule)">
  595. <summary>
  596. Adds a matching rule to the ones allready added by default and which is evaluated before all existing rules
  597. </summary>
  598. </member>
  599. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.ToString">
  600. <summary>
  601. Returns a string that represents the current object.
  602. </summary>
  603. <returns>
  604. A string that represents the current object.
  605. </returns>
  606. <filterpriority>2</filterpriority>
  607. </member>
  608. <member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.SelectionRules">
  609. <summary>
  610. Gets an ordered collection of selection rules that define what properties are included.
  611. </summary>
  612. </member>
  613. <member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.MatchingRules">
  614. <summary>
  615. Gets an ordered collection of matching rules that determine which subject properties are matched with which
  616. expectation properties.
  617. </summary>
  618. </member>
  619. <member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.AssertionRules">
  620. <summary>
  621. Gets an ordered collection of assertion rules that determine how subject properties are compared for equality with
  622. expectation properties.
  623. </summary>
  624. </member>
  625. <member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IsRecursive">
  626. <summary>
  627. Gets value indicating whether the equality check will include nested collections and complex types.
  628. </summary>
  629. </member>
  630. <member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.CyclicReferenceHandling">
  631. <summary>
  632. Gets value indicating how cyclic references should be handled. By default, it will throw an exception.
  633. </summary>
  634. </member>
  635. <member name="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Restriction`1">
  636. <summary>
  637. Defines additional overrides when used with <see cref="!:EquivalencyAssertionOptions&lt;TSubject&gt;.When"/>
  638. </summary>
  639. </member>
  640. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Restriction`1.WhenTypeIs``1">
  641. <summary>
  642. Allows overriding the way structural equality is applied to (nested) objects of tyoe <typeparamref name="TPropertyType"/>
  643. </summary>
  644. </member>
  645. <member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Restriction`1.When(System.Func{FluentAssertions.Equivalency.ISubjectInfo,System.Boolean})">
  646. <summary>
  647. Allows overriding the way structural equality is applied to particular properties.
  648. </summary>
  649. <param name="predicate">
  650. A predicate based on the <see cref="T:FluentAssertions.Equivalency.ISubjectInfo"/> of the subject that is used to identify the property for which the
  651. override applies.
  652. </param>
  653. </member>
  654. <member name="M:FluentAssertions.Equivalency.ComplexTypeEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext)">
  655. <summary>
  656. Gets a value indicating whether this step can handle the current subject and/or expectation.
  657. </summary>
  658. </member>
  659. <member name="M:FluentAssertions.Equivalency.ComplexTypeEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator)">
  660. <summary>
  661. Applies a step as part of the task to compare two objects for structural equality.
  662. </summary>
  663. <value>
  664. Should return <c>true</c> if the subject matches the expectation or if no additional assertions
  665. have to be executed. Should return <c>false</c> otherwise.
  666. </value>
  667. <remarks>
  668. May throw when preconditions are not met or if it detects mismatching data.
  669. </remarks>
  670. </member>
  671. <member name="M:FluentAssertions.Equivalency.EnumerableEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext)">
  672. <summary>
  673. Gets a value indicating whether this step can handle the current subject and/or expectation.
  674. </summary>
  675. </member>
  676. <member name="M:FluentAssertions.Equivalency.EnumerableEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator)">
  677. <summary>
  678. Applies a step as part of the task to compare two objects for structural equality.
  679. </summary>
  680. <value>
  681. Should return <c>true</c> if the subject matches the expectation or if no additional assertions
  682. have to be executed. Should return <c>false</c> otherwise.
  683. </value>
  684. <remarks>
  685. May throw when preconditions are not met or if it detects mismatching data.
  686. </remarks>
  687. </member>
  688. <member name="T:FluentAssertions.Numeric.ComparableTypeAssertions`1">
  689. <summary>
  690. Contains a number of methods to assert that an <see cref="T:System.IComparable`1"/> is in the expected state.
  691. </summary>
  692. </member>
  693. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.Be(`0,System.String,System.Object[])">
  694. <summary>
  695. Asserts that the subject is considered equal to another object according to the implementation of <see cref="T:System.IComparable`1"/>.
  696. </summary>
  697. <param name="expected">
  698. The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
  699. </param>
  700. <param name="reason">
  701. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  702. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  703. </param>
  704. <param name="reasonArgs">
  705. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  706. </param>
  707. </member>
  708. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.NotBe(`0,System.String,System.Object[])">
  709. <summary>
  710. Asserts that the subject is not equal to another object according to its implementation of <see cref="T:System.IComparable`1"/>.
  711. </summary>
  712. <param name="expected">
  713. The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
  714. </param>
  715. <param name="reason">
  716. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  717. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  718. </param>
  719. <param name="reasonArgs">
  720. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  721. </param>
  722. </member>
  723. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeLessThan(`0,System.String,System.Object[])">
  724. <summary>
  725. Asserts that the subject is less than another object according to its implementation of <see cref="T:System.IComparable`1"/>.
  726. </summary>
  727. <param name="expected">
  728. The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
  729. </param>
  730. <param name="reason">
  731. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  732. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  733. </param>
  734. <param name="reasonArgs">
  735. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  736. </param>
  737. </member>
  738. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeLessOrEqualTo(`0,System.String,System.Object[])">
  739. <summary>
  740. Asserts that the subject is less than or equal to another object according to its implementation of <see cref="T:System.IComparable`1"/>.
  741. </summary>
  742. <param name="expected">
  743. The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
  744. </param>
  745. <param name="reason">
  746. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  747. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  748. </param>
  749. <param name="reasonArgs">
  750. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  751. </param>
  752. </member>
  753. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeGreaterThan(`0,System.String,System.Object[])">
  754. <summary>
  755. Asserts that the subject is greater than another object according to its implementation of <see cref="T:System.IComparable`1"/>.
  756. </summary>
  757. <param name="expected">
  758. The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
  759. </param>
  760. <param name="reason">
  761. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  762. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  763. </param>
  764. <param name="reasonArgs">
  765. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  766. </param>
  767. </member>
  768. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeGreaterOrEqualTo(`0,System.String,System.Object[])">
  769. <summary>
  770. Asserts that the subject is greater than or equal to another object according to its implementation of <see cref="T:System.IComparable`1"/>.
  771. </summary>
  772. <param name="expected">
  773. The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
  774. </param>
  775. <param name="reason">
  776. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  777. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  778. </param>
  779. <param name="reasonArgs">
  780. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  781. </param>
  782. </member>
  783. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeInRange(`0,`0,System.String,System.Object[])">
  784. <summary>
  785. Asserts that a value is within a range.
  786. </summary>
  787. <remarks>
  788. Where the range is continuous or incremental depends on the actual type of the value.
  789. </remarks>
  790. <param name="minimumValue">
  791. The minimum valid value of the range.
  792. </param>
  793. <param name="maximumValue">
  794. The maximum valid value of the range.
  795. </param>
  796. <param name="reason">
  797. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  798. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  799. </param>
  800. <param name="reasonArgs">
  801. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  802. </param>
  803. </member>
  804. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.NotBeNull(System.String,System.Object[])">
  805. <summary>
  806. Asserts that a nullable numeric value is not <c>null</c>.
  807. </summary>
  808. <param name="reason">
  809. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  810. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  811. </param>
  812. <param name="reasonArgs">
  813. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  814. </param>
  815. </member>
  816. <member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeNull(System.String,System.Object[])">
  817. <summary>
  818. Asserts that a nullable numeric value is <c>null</c>.
  819. </summary>
  820. <param name="reason">
  821. A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
  822. is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
  823. </param>
  824. <param name="reasonArgs">
  825. Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
  826. </param>
  827. </member>
  828. <member name="P:FluentAssertions.Numeric.ComparableTypeAssertions`1.Subject">
  829. <summary>
  830. Gets the object which value is being asserted.
  831. </summary>
  832. </member>
  833. <member name="T:FluentAssertions.ComparisonMode">
  834. <summary>
  835. Defines the way <see cref="!:ExceptionAssertions&lt;TException&gt;.WithMessage(string)"/> compares the expected exception
  836. message with the actual one.
  837. </summary>
  838. </member>
  839. <member name="F:FluentAssertions.ComparisonMode.Exact">
  840. <summary>
  841. The message must match exactly, including the casing of the characters.
  842. </summary>
  843. </member>
  844. <member name="F:FluentAssertions.ComparisonMode.Equivalent">
  845. <summary>
  846. The message must match except for the casing of the characters.
  847. </summary>
  848. </member>
  849. <member name="F:FluentAssertions.ComparisonMode.StartWith">
  850. <summary>
  851. The message must start with the exact text, including the casing of the characters..
  852. </summary>
  853. </member>
  854. <member name="F:FluentAssertions.ComparisonMode.StartWithEquivalent">
  855. <summary>
  856. The message must start with the text except for the casing of the characters.
  857. </summary>
  858. </member>
  859. <member name="F:FluentAssertions.ComparisonMode.Substring">
  860. <summary>
  861. The message must contain the exact text.
  862. </summary>
  863. </member>
  864. <member name="F:FluentAssertions.ComparisonMode.EquivalentSubstring">
  865. <summary>
  866. The message must contain the text except for the casing of the characters.
  867. </summary>
  868. </member>
  869. <member name="F:FluentAssertions.ComparisonMode.Wildcard">
  870. <summary>
  871. The message must match a wildcard pattern consisting of ordinary characters as well as * and ?.
  872. </summary>
  873. </member>
  874. <member name="T:FluentAssertions.Equivalency.CyclicReferenceHandling">
  875. <summary>
  876. Indication of how cyclic references should be handled when validating equality of nested properties.
  877. </summary>
  878. </member>
  879. <member name="F:FluentAssertions.Equivalency.CyclicReferenceHandling.Ignore">
  880. <summary>
  881. Cyclic references will be ignored.
  882. </summary

Large files files are truncated, but you can click here to view the full file